diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b99fdd92cc3..b29dceac80d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,5 @@ +(Replace this entire block of text) + Thank you for contributing to LangChain! Follow these steps to mark your pull request as ready for review. **If any of these steps are not completed, your PR will not be considered for review.** - [ ] **PR title**: Follows the format: {TYPE}({SCOPE}): {DESCRIPTION} @@ -9,14 +11,13 @@ Thank you for contributing to LangChain! Follow these steps to mark your pull re - feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert, release - Allowed `{SCOPE}` values (optional): - core, cli, langchain, standard-tests, docs, anthropic, chroma, deepseek, exa, fireworks, groq, huggingface, mistralai, nomic, ollama, openai, perplexity, prompty, qdrant, xai - - Note: the `{DESCRIPTION}` must not start with an uppercase letter. + - *Note:* the `{DESCRIPTION}` must not start with an uppercase letter. - Once you've written the title, please delete this checklist item; do not include it in the PR. - [ ] **PR message**: ***Delete this entire checklist*** and replace with - **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 to a relevant issue. - **Issue:** the issue # it fixes, if applicable (e.g. Fixes #123) - **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! - [ ] **Add tests and docs**: If you're adding a new integration, you must include: 1. A test for the integration, preferably unit tests that do not rely on network access, @@ -26,7 +27,7 @@ Thank you for contributing to LangChain! Follow these steps to mark your pull re 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. +- Please do not add dependencies to `pyproject.toml` files (even optional ones) unless they are **required** for unit tests. - Changes should be backwards compatible. +- Make sure optional dependencies are imported within a function. diff --git a/docs/docs/contributing/how_to/code/guidelines.mdx b/docs/docs/contributing/how_to/code/guidelines.mdx index 54bf05238d1..0fcffe9c2e9 100644 --- a/docs/docs/contributing/how_to/code/guidelines.mdx +++ b/docs/docs/contributing/how_to/code/guidelines.mdx @@ -3,9 +3,9 @@ Here are some things to keep in mind for all types of contributions: - Follow the ["fork and pull request"](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) workflow. -- Fill out the checked-in pull request template when opening pull requests. Note related issues and tag relevant maintainers. +- Fill out the checked-in pull request template when opening pull requests. Note related issues. - Ensure your PR passes formatting, linting, and testing checks before requesting a review. - - If you would like comments or feedback on your current progress, please open an issue or discussion and tag a maintainer. + - If you would like comments or feedback on your current progress, please open an issue or discussion. - See the sections on [Testing](setup.mdx#testing) and [Formatting and Linting](setup.mdx#formatting-and-linting) for how to run these checks locally. - Backwards compatibility is key. Your changes must not be breaking, except in case of critical bug and security fixes. - Look for duplicate PRs or issues that have already been opened before opening a new one.