mirror of
https://github.com/langchain-ai/langchain.git
synced 2026-10-13 13:19:22 +03:00
endrajeet
b45bf78d2e
changed "# 🌟Recognition" to "### 🌟 Recognition" to match the rest of the subheadings. Thank you for contributing to LangChain! - [ ] **PR title**: "package: description" - Where "package" is whichever of langchain, community, core, experimental, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes. - Example: "community: add foobar LLM" - [ ] **PR message**: ***Delete this entire checklist*** and replace with - **Description:** a description of the change - **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, 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. 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. See contribution guidelines for more: https://python.langchain.com/docs/contributing/ 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. - If you are adding something to community, do not re-import it in langchain. If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.
55 lines
2.8 KiB
Plaintext
55 lines
2.8 KiB
Plaintext
---
|
|
sidebar_position: 0
|
|
---
|
|
# Welcome Contributors
|
|
|
|
Hi there! Thank you for even being interested in contributing to LangChain.
|
|
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.
|
|
|
|
## 🗺️ Guidelines
|
|
|
|
### 👩💻 Ways to contribute
|
|
|
|
There are many ways to contribute to LangChain. Here are some common ways people contribute:
|
|
|
|
- [**Documentation**](/docs/contributing/documentation/style_guide): Help improve our docs, including this one!
|
|
- [**Code**](./code.mdx): Help us write code, fix bugs, or improve our infrastructure.
|
|
- [**Integrations**](integrations.mdx): Help us integrate with your favorite vendors and tools.
|
|
- [**Discussions**](https://github.com/langchain-ai/langchain/discussions): Help answer usage questions and discuss issues with users.
|
|
|
|
### 🚩 GitHub Issues
|
|
|
|
Our [issues](https://github.com/langchain-ai/langchain/issues) page is kept up to date with bugs, improvements, and feature requests.
|
|
|
|
There is a taxonomy of labels to help with sorting and discovery of issues of interest. Please use these to help organize issues.
|
|
|
|
If you start working on an issue, please assign it to yourself.
|
|
|
|
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.
|
|
|
|
We will try to keep these issues as up-to-date as possible, though
|
|
with the rapid rate of development in this field some may get out of date.
|
|
If you notice this happening, please let us know.
|
|
|
|
### 💭 GitHub Discussions
|
|
|
|
We have a [discussions](https://github.com/langchain-ai/langchain/discussions) page where users can ask usage questions, discuss design decisions, and propose new features.
|
|
|
|
If you are able to help answer questions, please do so! This will allow the maintainers to spend more time focused on development and bug fixing.
|
|
|
|
### 🙋 Getting Help
|
|
|
|
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.
|
|
|
|
In a similar vein, we do enforce certain linting, formatting, and documentation standards in the codebase.
|
|
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.
|
|
|
|
### 🌟 Recognition
|
|
|
|
If your contribution has made its way into a release, we will want to give you credit on Twitter (only if you want though)!
|
|
If you have a Twitter account you would like us to mention, please let us know in the PR or through another means.
|