Skip to content

Commit a5f1774

Browse files
authored
chore: update PR template (#32011)
1 parent a041314 commit a5f1774

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,34 @@
11
Thank you for contributing to LangChain!
22

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
713

814
- [ ] **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.
1016
- **Issue:** the issue # it fixes, if applicable
1117
- **Dependencies:** any dependencies required for this change
1218
- **Twitter handle:** if your PR gets announced, and you'd like a mention, we'll gladly shout you out!
1319

1420

1521
- [ ] **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.
1824

1925

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/
2127

2228
Additional guidelines:
2329
- 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.
2531
- Most PRs should not touch more than one package.
2632
- Changes should be backwards compatible.
2733

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

Comments
 (0)