Skip to content

Commit 74c0343

Browse files
authored
oss(contributing): refinements (#2983)
1 parent 796b3bb commit 74c0343

File tree

7 files changed

+34
-36
lines changed

7 files changed

+34
-36
lines changed

src/oss/contributing/code.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Contributing to code
33
sidebarTitle: Code
44
---
55

6-
Code contributions are always welcome! Whether you're fixing bugs, adding features, or improving performance, your contributions help deliver a better developer experience for thousands of developers.
6+
Code contributions are welcome! Whether you're fixing bugs, adding features, or improving performance, your contributions help deliver a better developer experience for thousands of developers.
77

88
## Getting started
99

@@ -384,7 +384,7 @@ Once you've reviewed the [contribution guidelines](#contribution-guidelines), fi
384384
<AccordionGroup>
385385
<Accordion title="Core packages" defaultOpen>
386386
- **[`deepagents`](https://github.com/langchain-ai/deepagents/tree/main/libs/deepagents#readme)** (located in `libs/deepagents/`): Core framework for building deep agents with planning, filesystem, and subagent capabilities
387-
- **[`deepagents-cli`](https://github.com/langchain-ai/deepagents/tree/main/libs/deepagents-cli#readme)** (located in `libs/deepagents-cli/`): Interactive terminal interface with conversation resume, web search, and sandboxes
387+
- **[`deepagents-cli`](https://github.com/langchain-ai/deepagents/tree/main/libs/cli#readme)** (located in `libs/cli/`): Interactive terminal interface with conversation resume, web search, and sandboxes
388388
</Accordion>
389389

390390
<Accordion title="Integration packages">

src/oss/contributing/implement-langchain.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,12 @@ Your integration package will typically implement a subclass of at least one of
1414
Chat models are subclasses of the @[`BaseChatModel`] class. They implement methods for generating chat completions, handling message formatting, and managing model parameters.
1515

1616
<Warning>
17-
The chat model integration guide is currently WIP. In the meantime, read the [chat model conceptual guide](/oss/langchain/models) for details on how LangChain chat models function.
17+
:::python
18+
The chat model integration guide is currently WIP. In the meantime, read the [chat model conceptual guide](/oss/langchain/models) for details on how LangChain chat models function. You may also refer to existing integrations in the [LangChain repo](https://github.com/langchain-ai/langchain/tree/master/libs/partners)
19+
:::
20+
:::js
21+
The chat model integration guide is currently WIP. In the meantime, read the [chat model conceptual guide](/oss/langchain/models) for details on how LangChain chat models function. You may also refer to existing integrations in the [LangChain repo](https://github.com/langchain-ai/langchainjs/tree/main/libs/providers)
22+
:::
1823
</Warning>
1924
</Tab>
2025
<Tab title="Tools">

src/oss/contributing/integrations-langchain.mdx

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ sidebarTitle: Guide
55

66
**Integrations are a core component of LangChain.**
77

8-
LangChain provides standard interfaces for several different components (language models, vector stores, etc) that are crucial when building LLM applications. Contributing an integration helps expand LangChain's ecosystem and makes your service discoverable to millions of developers.
8+
LangChain provides standard interfaces for several different components (language models, vector stores, etc) that are crucial when building LLM applications. Implementing a new integration helps expand LangChain's ecosystem and makes your service discoverable to millions of developers.
99

10-
## Why contribute an integration to LangChain?
10+
## Why implement a LangChain integration?
1111

1212
<Card title="Discoverability" icon="search">
13-
LangChain is the most used framework for building LLM applications, with over 20 million monthly downloads.
13+
LangChain is the most used framework for building LLM applications, with over 200 million monthly downloads.
1414
</Card>
1515

1616
<Card title="Interoperability" icon="refresh">
@@ -26,6 +26,7 @@ LangChain provides standard interfaces for several different components (languag
2626
While any component can be integrated into LangChain, there are specific types of integrations we encourage more:
2727

2828
**Integrate these ✅**:
29+
2930
- [**Chat Models**](/oss/integrations/chat): Most actively used component type
3031
- [**Tools/Toolkits**](/oss/integrations/tools): Enable agent capabilities
3132
- [**Retrievers**](/oss/integrations/retrievers): Core to RAG applications
@@ -41,6 +42,7 @@ Be aware that we feature third-party sandbox integrations only when:
4142
</Accordion>
4243

4344
**Not these ❌**:
45+
4446
- **LLMs (Text-Completion Models)**: Deprecated in favor of [Chat Models](/oss/integrations/chat)
4547
- [**Document Loaders**](/oss/integrations/document_loaders): High maintenance burden
4648
- [**Key-Value Stores**](/oss/integrations/stores): Limited usage
@@ -55,10 +57,6 @@ Be aware that we feature third-party sandbox integrations only when:
5557
## How to contribute an integration
5658

5759
<Steps>
58-
<Step title="Confirm eligibility">
59-
Verify that your integration is in the list of [encouraged components](#components-to-integrate) we are currently accepting.
60-
</Step>
61-
6260
<Step title="Implement your package">
6361
<Card title="How to implement a LangChain integration" icon="link" href="/oss/contributing/implement-langchain" arrow />
6462
</Step>
@@ -81,14 +79,12 @@ Be aware that we feature third-party sandbox integrations only when:
8179

8280
- [Chat models](https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/chat/TEMPLATE.mdx)
8381
- [Tools and toolkits](https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/tools/TEMPLATE.mdx)
84-
- [Retrievers](https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/retrievers/TEMPLATE.mdx)
82+
- Retrievers - Coming soon
8583
- Text splitters - Coming soon
8684
- Embedding models - Coming soon
8785
- [Vector stores](https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/vectorstores/TEMPLATE.mdx)
8886
- Document loaders - Coming soon
8987
- Key-value stores - Coming soon
90-
91-
For reference docs, please open an issue on the repo so that a maintainer can add them.
9288
</Accordion>
9389
</Step>
9490

src/oss/contributing/overview.mdx

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ LangChain has helped form the largest developer community in generative AI, and
4040
</Step>
4141
</Steps>
4242

43-
If you are adding an issue, please try to keep it focused on a single topic. If two issues are related, or blocking, please [link them](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) rather than combining them. For example,
43+
If you are adding an issue, please try to keep it focused on a single topic. If two issues are related, or blocking, please [link them](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) rather than combining them. For example:
4444

4545
```text
4646
This issue is blocked by #123 and related to #456.
@@ -70,12 +70,7 @@ LangChain has helped form the largest developer community in generative AI, and
7070
:::
7171
</Step>
7272
<Step title="Discuss">
73-
:::python
74-
If no requests exist, start a new discussion under the [relevant category](https://forum.langchain.com/c/help/langchain/14) so that project maintainers and the community can provide feedback.
75-
:::
76-
:::js
77-
If no requests exist, start a new discussion under the [relevant category](https://forum.langchain.com/c/help/langchain/13) so that project maintainers and the community can provide feedback.
78-
:::
73+
If no requests exist, start a new discussion under the [relevant category](https://forum.langchain.com/c/oss-product-help-lc-and-lg/16) so that project maintainers and the community can provide feedback.
7974
</Step>
8075
<Step title="Describe">
8176
Be sure to describe the use case and why it would be valuable to others. If possible, provide examples or mockups where applicable. Outline test cases that should pass.
@@ -84,7 +79,7 @@ LangChain has helped form the largest developer community in generative AI, and
8479
</Accordion>
8580

8681
<Accordion title="Improve documentation" icon="book">
87-
Documentation improvements are always welcome! We strive to keep our docs clear and comprehensive, and your perspective can make a big difference.
82+
Documentation improvements are welcome! We strive to keep our docs clear and comprehensive, and your perspective can make a big difference.
8883

8984
<Card title="How to propose changes to the documentation" href="/oss/contributing/documentation" arrow>Guide</Card>
9085
</Accordion>
@@ -100,16 +95,16 @@ LangChain has helped form the largest developer community in generative AI, and
10095

10196
:::python
10297
<Columns cols={3}>
103-
<Card title="LangChain" icon="link" href="https://github.com/langchain-ai/langchain/labels">Labels</Card>
104-
<Card title="LangGraph" icon="topology-ring" href="https://github.com/langchain-ai/langgraph/labels">Labels</Card>
105-
<Card title="Deep Agents" icon="robot" href="https://github.com/langchain-ai/deepagents/labels">Labels</Card>
98+
<Card title="LangChain" icon="link" href="https://github.com/langchain-ai/langchain/labels?q=help+wanted">Labels</Card>
99+
<Card title="LangGraph" icon="topology-ring" href="https://github.com/langchain-ai/langgraph/labels?q=help+wanted">Labels</Card>
100+
<Card title="Deep Agents" icon="robot" href="https://github.com/langchain-ai/deepagents/labels?q=help+wanted">Labels</Card>
106101
</Columns>
107102
:::
108103
:::js
109104
<Columns cols={3}>
110-
<Card title="LangChain" icon="link" href="https://github.com/langchain-ai/langchainjs/labels">Labels</Card>
111-
<Card title="LangGraph" icon="topology-ring" href="https://github.com/langchain-ai/langgraphjs/labels">Labels</Card>
112-
<Card title="Deep Agents" icon="robot" href="https://github.com/langchain-ai/deepagentsjs/labels">Labels</Card>
105+
<Card title="LangChain" icon="link" href="https://github.com/langchain-ai/deepagents/labels?q=help+wanted">Labels</Card>
106+
<Card title="LangGraph" icon="topology-ring" href="https://github.com/langchain-ai/langgraphjs/labels?q=help+wanted">Labels</Card>
107+
<Card title="Deep Agents" icon="robot" href="https://github.com/langchain-ai/deepagentsjs/labels?q=help+wanted">Labels</Card>
113108
</Columns>
114109
:::
115110
</Accordion>
@@ -123,10 +118,14 @@ LangChain has helped form the largest developer community in generative AI, and
123118

124119
Generative AI can be a useful tool for contributors, but like any tool should be used with critical thinking and good judgement.
125120

126-
We encourage contributors to use AI tools efficiently where they help. However, AI assistance must be paired with meaningful human intervention, judgement, and contextual understanding. **If the human effort required to create a pull request is less than the effort required for maintainers to review it, that contribution should not be submitted.**
121+
AI assistance must be paired with meaningful human intervention, judgement, and contextual understanding. **If the human effort required to create a pull request is less than the effort required for maintainers to review it, that contribution should not be submitted.**
122+
123+
We struggle when contributors' entire work (code changes, documentation updates, pull request descriptions) are LLM-generated. These drive-by contributions often mean well but miss the mark in terms of contextual relevance, accuracy, and quality. Mass automated contributions represent a denial-of-service attack on our human effort.
127124

128-
We struggle when contributors' entire work (code changes, documentation updates, pull request descriptions) are LLM-generated. These drive-by contributions often mean well but miss the mark in terms of contextual relevance, accuracy, and quality. Mass automated contributions like these represent a denial-of-service attack on our human effort.
125+
The following guidelines must be met for Pull Requests that include AI-generated content:
129126

130-
**We will close pull requests and issues that appear to be low-effort, AI-generated spam.**
127+
* The Pull Request must fill in the repository's pull request template.
128+
* The Pull Request must identify itself as AI generated, including the name of the agent used.
129+
* The Pull Request must link to a issue or discussion where a solution has been approved by a maintainer.
131130

132-
With great tools comes great responsibility.
131+
The maintainer reserves the right to close PRs without comment if the above are not met. **We will close pull requests and issues that appear to be low-effort, AI-generated spam.**

src/oss/contributing/publish-langchain.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,7 @@ Depending on the type of integration you have built, you will need to create dif
7272
<CardGroup>
7373
<Card title="Chat models" icon="message" href="https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/chat/TEMPLATE.mdx" arrow/>
7474
<Card title="Tools/toolkits" icon="tool" href="https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/tools/TEMPLATE.mdx" arrow/>
75-
<Card title="Retrievers" icon="search" href="https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/retrievers/TEMPLATE.mdx" arrow/>
7675
<Card title="Vector stores" icon="database" href="https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/vectorstores/TEMPLATE.mdx" arrow/>
77-
<Card title="Embedding models" icon="stack-2" href="https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/text_embedding/TEMPLATE.mdx" arrow/>
7876
</CardGroup>
7977

8078
<Tip>

src/oss/deepagents/cli/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,12 @@ The Deep Agents CLI has the following built-in capabilities:
9696
<Step title="Install and run the CLI" icon="terminal">
9797
<CodeGroup>
9898
```bash Quick install (recommended)
99-
curl -LsSf https://raw.githubusercontent.com/langchain-ai/deepagents/main/scripts/install.sh | bash
99+
curl -LsSf https://raw.githubusercontent.com/langchain-ai/deepagents/refs/heads/main/libs/cli/scripts/install.sh | bash
100100
```
101101

102102
```bash Quick install with extra model providers
103103
# (OpenAI is included by default)
104-
DEEPAGENTS_EXTRAS="anthropic,groq" curl -LsSf https://raw.githubusercontent.com/langchain-ai/deepagents/main/scripts/install.sh | bash
104+
DEEPAGENTS_EXTRAS="anthropic,groq" curl -LsSf https://raw.githubusercontent.com/langchain-ai/deepagents/refs/heads/main/libs/cli/scripts/install.sh | bash
105105
```
106106

107107
```bash Install globally with uv

src/oss/deepagents/cli/providers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The CLI integrates automatically with the [following model providers](#provider-
1616

1717
```bash
1818
# Quick install with chosen providers (OpenAI included automatically)
19-
DEEPAGENTS_EXTRAS="anthropic,groq" curl -LsSf https://raw.githubusercontent.com/langchain-ai/deepagents/main/scripts/install.sh | bash
19+
DEEPAGENTS_EXTRAS="anthropic,groq" curl -LsSf https://raw.githubusercontent.com/langchain-ai/deepagents/refs/heads/main/libs/cli/scripts/install.sh | bash
2020

2121
# Or install directly with uv
2222
uv tool install 'deepagents-cli[anthropic,groq]'

0 commit comments

Comments
 (0)