Skip to content

Commit

Permalink
Add CONTRIBUTING.md guidelines (#54)
Browse files Browse the repository at this point in the history
Add contributing.md. Inserting this in the root of the project, so it's
easier to find. If folks feel strongly can put in in .github.
  • Loading branch information
eyurtsev authored Oct 18, 2023
1 parent ada5d10 commit 779b8e1
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing[

## Contributor License Agreement

We are grateful to the contributors who help evolve LangServe and dedicate their time to the project. As the primary sponsor of LangServe, LangChain, Inc. aims to build products in the open that benefit thousands of developers while allowing us to build a sustainable business. For all code contributions to LangServe, we ask that contributors complete and sign a Contributor License Agreement (“CLA”). The agreement between contributors and the project is explicit, so LangServe users can be confident in the legal status of the source code and their right to use it.The CLA does not change the terms of the underlying license, LangServe License, used by our software.

Before you can contribute to LangServe, a bot will comment on the PR asking you to agree to the CLA if you haven't already. Agreeing to the CLA is required before code can be merged and only needs to happen on the first contribution to the project. All subsequent contributions will fall under the same CLA.

## 🗺️ Guidelines

### Dependency Management: Poetry and other env/dependency managers

This project uses [Poetry](https://python-poetry.org/) v1.6.1+ as a dependency manager.

### Local Development Dependencies

Install langserve development requirements (for running langchain, running examples, linting, formatting, tests, and coverage):

```bash
poetry install --with test,dev
```

Then verify that tests pass:

```bash
make test
```

### Formatting and Linting

Run these locally before submitting a PR; the CI system will check also.

#### Code Formatting

Formatting for this project is done via a combination of [Black](https://black.readthedocs.io/en/stable/) and [ruff](https://docs.astral.sh/ruff/rules/).

To run formatting for this project:

```bash
make format
```

#### Linting

Linting for this project is done via a combination of [Black](https://black.readthedocs.io/en/stable/), [ruff](https://docs.astral.sh/ruff/rules/), and [mypy](http://mypy-lang.org/).

To run linting for this project:

```bash
make lint
```

0 comments on commit 779b8e1

Please sign in to comment.