|
1 | 1 | Thank you for contributing to LangChain!
|
2 | 2 |
|
3 |
| -- [ ] **PR title**: "package: description" |
4 |
| - - Where "package" is whichever of langchain, core, etc. is being modified. Use "docs: ..." for purely docs changes, "infra: ..." for CI changes. |
5 |
| - - Example: "core: add foobar LLM" |
6 |
| - |
| 3 | +- [ ] **PR title**: Follows the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/): {TYPE}({SCOPE}): {DESCRIPTION} |
| 4 | + - The `{DESCRIPTION}` must not start with an uppercase letter. |
| 5 | + - Examples: |
| 6 | + - feat(core): add multi-tenant support |
| 7 | + - fix(cli): resolve flag parsing error |
| 8 | + - docs(openai): update API usage examples |
| 9 | + - Allowed `{TYPE}` values: |
| 10 | + - feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert, release |
| 11 | + - Allowed `{SCOPE}` values (optional): |
| 12 | + - core, cli, langchain, standard-tests, docs, anthropic, chroma, deepseek, exa, fireworks, groq, huggingface, mistralai, nomic, ollama, openai, perplexity, prompty, qdrant, xai |
7 | 13 |
|
8 | 14 | - [ ] **PR message**: ***Delete this entire checklist*** and replace with
|
9 |
| - - **Description:** a description of the change |
| 15 | + - **Description:** a description of the change. Include a [closing keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) if applicable. |
10 | 16 | - **Issue:** the issue # it fixes, if applicable
|
11 | 17 | - **Dependencies:** any dependencies required for this change
|
12 | 18 | - **Twitter handle:** if your PR gets announced, and you'd like a mention, we'll gladly shout you out!
|
13 | 19 |
|
14 | 20 |
|
15 | 21 | - [ ] **Add tests and docs**: If you're adding a new integration, please include
|
16 |
| - 1. a test for the integration, preferably unit tests that do not rely on network access, |
17 |
| - 2. an example notebook showing its use. It lives in `docs/docs/integrations` directory. |
| 22 | + 1. A test for the integration, preferably unit tests that do not rely on network access, |
| 23 | + 2. An example notebook showing its use. It lives in `docs/docs/integrations` directory. |
18 | 24 |
|
19 | 25 |
|
20 |
| -- [ ] **Lint and test**: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified. See contribution guidelines for more: https://python.langchain.com/docs/contributing/ |
| 26 | +- [ ] **Lint and test**: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified. We will not consider a PR unless these three are passing in CI. See contribution guidelines for more: https://python.langchain.com/docs/contributing/ |
21 | 27 |
|
22 | 28 | Additional guidelines:
|
23 | 29 | - Make sure optional dependencies are imported within a function.
|
24 |
| -- Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests. |
| 30 | +- Please do not add dependencies to `pyproject.toml` files (even optional ones) unless they are **required** for unit tests. |
25 | 31 | - Most PRs should not touch more than one package.
|
26 | 32 | - Changes should be backwards compatible.
|
27 | 33 |
|
28 |
| -If no one reviews your PR within a few days, please @-mention one of baskaryan, eyurtsev, ccurme, vbarda, hwchase17. |
| 34 | +If no one reviews your PR within a few days, please @-mention one of eyurtsev, ccurme, mdrxy. |
0 commit comments