diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..2a6380594 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,31 @@ +Thank you for contributing to LangGraph! 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): + - langgraph, docs, cli, checkpoint, checkpoint-postgres, checkpoint-sqlite, prebuilt, scheduler-kafka, sdk-py + - 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. + - **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! + +- [ ] **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](https://github.com/langchain-ai/langgraph/blob/main/CONTRIBUTING.md) 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. diff --git a/README.md b/README.md index 26550f5b4..2f76733d6 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ While LangGraph can be used standalone, it also integrates seamlessly with any L - [Guides](https://langchain-ai.github.io/langgraph/how-tos/): Quick, actionable code snippets for topics such as streaming, adding memory & persistence, and design patterns (e.g. branching, subgraphs, etc.). - [Reference](https://langchain-ai.github.io/langgraph/reference/graphs/): Detailed reference on core classes, methods, how to use the graph and checkpointing APIs, and higher-level prebuilt components. -- [Examples](https://langchain-ai.github.io/langgraph/tutorials/overview/): Guided examples on getting started with LangGraph. +- [Examples](https://langchain-ai.github.io/langgraph/examples/): Guided examples on getting started with LangGraph. - [LangChain Forum](https://forum.langchain.com/): Connect with the community and share all of your technical questions, ideas, and feedback. - [LangChain Academy](https://academy.langchain.com/courses/intro-to-langgraph): Learn the basics of LangGraph in our free, structured course. - [Templates](https://langchain-ai.github.io/langgraph/concepts/template_applications/): Pre-built reference apps for common agentic workflows (e.g. ReAct agent, memory, retrieval etc.) that can be cloned and adapted.