langchain/.github/PULL_REQUEST_TEMPLATE.md

21 lines
1.2 KiB
Markdown
Raw Normal View History

2023-06-21 17:03:52 +00:00
<!-- Thank you for contributing to LangChain!
2023-12-20 19:53:38 +00:00
Please title your PR "<package>: <description>", where <package> is whichever of langchain, community, core, experimental, etc. is being modified.
2023-08-10 18:10:06 +00:00
Replace this entire comment with:
2023-09-13 16:35:48 +00:00
- **Description:** a description of the change,
2023-12-20 19:53:38 +00:00
- **Issue:** the issue # it fixes if applicable,
2023-09-13 16:35:48 +00:00
- **Dependencies:** any dependencies required for this change,
- **Twitter handle:** we announce bigger features on Twitter. If your PR gets announced, and you'd like a mention, we'll gladly shout you out!
2023-06-21 17:03:52 +00:00
2023-12-20 19:53:38 +00:00
Please make sure your PR is passing linting and testing before submitting. Run `make format`, `make lint` and `make test` from the root of the package you've modified to check this locally.
2023-08-10 18:10:06 +00:00
2023-12-20 19:53:38 +00:00
See contribution guidelines for more information on how to write/run tests, lint, etc: https://python.langchain.com/docs/contributing/
2023-07-18 20:22:28 +00:00
2023-06-21 17:03:52 +00:00
If you're adding a new integration, please include:
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
2023-09-13 16:35:48 +00:00
If no one reviews your PR within a few days, please @-mention one of @baskaryan, @eyurtsev, @hwchase17.
2023-05-08 15:34:37 +00:00
-->