langchain/.github/PULL_REQUEST_TEMPLATE.md

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}

  • Examples:
    • feat(core): add multi-tenant support
    • fix(cli): resolve flag parsing error
    • docs(openai): update API usage examples
  • Allowed {TYPE} values:
    • 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.
  • 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 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,
  2. An example notebook showing its use. It lives in docs/docs/integrations directory.

• 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.

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.