langchain/.github/PULL_REQUEST_TEMPLATE.md

25 lines
1.8 KiB
Markdown
Raw Normal View History

2024-02-13 00:17:30 +00:00
Thank you for contributing to LangChain!
2023-06-21 17:03:52 +00:00
2024-02-13 00:17:30 +00:00
Checklist:
2023-12-20 19:53:38 +00:00
2024-02-13 00:17:30 +00:00
- [ ] PR title: Please title your PR "package: description", where "package" is whichever of langchain, community, core, experimental, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes.
- Example: "community: add foobar LLM"
2024-02-13 00:19:14 +00:00
- [ ] PR message: **Delete this entire template message** and replace it with the following bulleted list
2024-02-13 00:17:30 +00:00
- **Description:** a description of the change
- **Issue:** the issue # it fixes, if applicable
- **Dependencies:** any dependencies required for this change
- **Twitter handle:** if your PR gets announced, and you'd like a mention, we'll gladly shout you out!
- [ ] Pass lint and test: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified to check that you're passing lint and testing. See contribution guidelines for more information on how to write/run tests, lint, etc: https://python.langchain.com/docs/contributing/
- [ ] Add tests and docs: If you're adding a new integration, please include
2023-06-21 17:03:52 +00:00
1. a test for the integration, preferably unit tests that do not rely on network access,
2023-12-20 19:53:38 +00:00
2. an example notebook showing its use. It lives in `docs/docs/integrations` directory.
2023-06-21 17:03:52 +00:00
2024-02-13 00:17:30 +00:00
Additional guidelines:
- Make sure optional dependencies are imported within a function.
- Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests.
- Most PRs should not touch more than one package.
- Changes should be backwards compatible.
- If you are adding something to community, do not re-import it in langchain.
2024-02-14 05:29:22 +00:00
If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, hwchase17.