2022-12-12 14:07:40 +00:00
# Contributing to LangChain
Hi there! Thank you for even being interested in contributing to LangChain.
2023-10-26 15:56:28 +00:00
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether they involve new features, improved infrastructure, better documentation, or bug fixes.
2023-05-11 07:05:25 +00:00
2023-12-17 20:55:49 +00:00
To learn about how to contribute, please follow the [guides here ](https://python.langchain.com/docs/contributing/ )
2022-12-12 14:07:40 +00:00
2023-12-17 20:55:49 +00:00
## 🗺️ Guidelines
2023-05-11 07:05:25 +00:00
2023-12-17 20:55:49 +00:00
### 👩💻 Ways to contribute
2023-05-11 07:05:25 +00:00
2023-12-17 20:55:49 +00:00
There are many ways to contribute to LangChain. Here are some common ways people contribute:
2023-05-11 07:05:25 +00:00
2023-12-17 20:55:49 +00:00
- [**Documentation** ](https://python.langchain.com/docs/contributing/documentation ): Help improve our docs, including this one!
- [**Code** ](https://python.langchain.com/docs/contributing/code ): Help us write code, fix bugs, or improve our infrastructure.
- [**Integrations** ](https://python.langchain.com/docs/contributing/integration ): Help us integrate with your favorite vendors and tools.
2022-12-12 14:07:40 +00:00
### 🚩GitHub Issues
2023-10-26 15:56:28 +00:00
Our [issues ](https://github.com/langchain-ai/langchain/issues ) page is kept up to date with bugs, improvements, and feature requests.
2022-12-12 14:07:40 +00:00
2023-10-26 15:56:28 +00:00
There is a taxonomy of labels to help with sorting and discovery of issues of interest. Please use these to help organize issues.
2022-12-12 14:07:40 +00:00
If you start working on an issue, please assign it to yourself.
2023-05-11 07:05:25 +00:00
If you are adding an issue, please try to keep it focused on a single, modular bug/improvement/feature.
If two issues are related, or blocking, please link them rather than combining them.
2022-12-12 14:07:40 +00:00
2023-09-17 23:35:18 +00:00
We will try to keep these issues as up-to-date as possible, though
Update CONTRIBUTING.md (#9817)
<!-- Thank you for contributing to LangChain!
Replace this entire comment with:
- Description: a description of the change,
- Issue: the issue # it fixes (if applicable),
- Dependencies: any dependencies required for this change,
- Tag maintainer: for a quicker response, tag the relevant maintainer
(see below),
- 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!
Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` to check this
locally.
See contribution guidelines for more information on how to write/run
tests, lint, etc:
https://github.com/hwchase17/langchain/blob/master/.github/CONTRIBUTING.md
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,
2. an example notebook showing its use. These live is docs/extras
directory.
If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17, @rlancemartin.
-->
Hi LangChain :) Thank you for such a great project!
I was going through the CONTRIBUTING.md and found a few minor issues.
2023-08-28 13:38:34 +00:00
with the rapid rate of development in this field some may get out of date.
2023-05-11 07:05:25 +00:00
If you notice this happening, please let us know.
2022-12-12 14:07:40 +00:00
### 🙋Getting Help
2023-05-11 07:05:25 +00:00
Our goal is to have the simplest developer setup possible. Should you experience any difficulty getting setup, please
contact a maintainer! Not only do we want to help get you unblocked, but we also want to make sure that the process is
smooth for future contributors.
2022-12-12 14:07:40 +00:00
In a similar vein, we do enforce certain linting, formatting, and documentation standards in the codebase.
2023-05-11 07:05:25 +00:00
If you are finding these difficult (or even just annoying) to work with, feel free to contact a maintainer for help -
we do not want these to get in the way of getting good code into the codebase.
2022-12-12 14:07:40 +00:00
2023-12-17 20:55:49 +00:00
### Contributor Documentation
2023-05-11 07:05:25 +00:00
2023-12-17 20:55:49 +00:00
To learn about how to contribute, please follow the [guides here ](https://python.langchain.com/docs/contributing/ )
