Skip to content

Commit 0807711

Browse files
authored
chore: update contribution guidelines and templates to direct users to the LangChain Forum (#32050)
1 parent 7a36d6b commit 0807711

File tree

10 files changed

+127
-289
lines changed

10 files changed

+127
-289
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,8 @@
33
Hi there! Thank you for even being interested in contributing to LangChain.
44
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.
55

6-
To learn how to contribute to LangChain, please follow the [contribution guide here](https://python.langchain.com/docs/contributing/).
6+
To learn how to contribute to LangChain, please follow the [contribution guide here](https://python.langchain.com/docs/contributing/).
7+
8+
## New features
9+
10+
For new features, please start a new [discussion](https://forum.langchain.com/), where the maintainers will help with scoping out the necessary changes.

.github/DISCUSSION_TEMPLATE/ideas.yml

Lines changed: 0 additions & 38 deletions
This file was deleted.

.github/DISCUSSION_TEMPLATE/q-a.yml

Lines changed: 0 additions & 122 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,42 @@
11
name: "\U0001F41B Bug Report"
2-
description: Report a bug in LangChain. To report a security issue, please instead use the security option below. For questions, please use the GitHub Discussions.
3-
labels: ["02 Bug Report"]
2+
description: Report a bug in LangChain. To report a security issue, please instead use the security option below. For questions, please use the LangChain forum.
3+
labels: ["bug"]
44
body:
55
- type: markdown
66
attributes:
7-
value: >
7+
value: |
88
Thank you for taking the time to file a bug report.
9-
10-
Use this to report bugs in LangChain.
11-
12-
If you're not certain that your issue is due to a bug in LangChain, please use [GitHub Discussions](https://github.com/langchain-ai/langchain/discussions)
13-
to ask for help with your issue.
14-
9+
10+
Use this to report BUGS in LangChain. For usage questions, feature requests and general design questions, please use the [LangChain Forum](https://forum.langchain.com/).
11+
1512
Relevant links to check before filing a bug report to see if your issue has already been reported, fixed or
1613
if there's another way to solve your problem:
17-
18-
[LangChain documentation with the integrated search](https://python.langchain.com/docs/get_started/introduction),
19-
[API Reference](https://python.langchain.com/api_reference/),
20-
[GitHub search](https://github.com/langchain-ai/langchain),
21-
[LangChain Github Discussions](https://github.com/langchain-ai/langchain/discussions),
22-
[LangChain Github Issues](https://github.com/langchain-ai/langchain/issues?q=is%3Aissue),
23-
[LangChain ChatBot](https://chat.langchain.com/)
14+
15+
* [LangChain Forum](https://forum.langchain.com/),
16+
* [LangChain Github Issues](https://github.com/langchain-ai/langchain/issues?q=is%3Aissue),
17+
* [LangChain documentation with the integrated search](https://python.langchain.com/docs/get_started/introduction),
18+
* [LangChain how-to guides](https://langchain-ai.github.io/langgraph/how-tos/),
19+
* [API Reference](https://python.langchain.com/api_reference/),
20+
* [LangChain ChatBot](https://chat.langchain.com/)
21+
* [GitHub search](https://github.com/langchain-ai/langchain),
2422
- type: checkboxes
2523
id: checks
2624
attributes:
2725
label: Checked other resources
2826
description: Please confirm and check all the following options.
2927
options:
30-
- label: I added a very descriptive title to this issue.
28+
- label: This is a bug, not a usage question. For questions, please use the LangChain Forum (https://forum.langchain.com/).
29+
required: true
30+
- label: I added a clear and descriptive title that summarizes this issue.
3131
required: true
3232
- label: I used the GitHub search to find a similar question and didn't find it.
3333
required: true
3434
- label: I am sure that this is a bug in LangChain rather than my code.
3535
required: true
3636
- label: The bug is not resolved by updating to the latest stable version of LangChain (or the specific integration package).
3737
required: true
38+
- label: I read what a minimal reproducible example is (https://stackoverflow.com/help/minimal-reproducible-example).
39+
required: true
3840
- label: I posted a self-contained, minimal, reproducible example. A maintainer can copy it and run it AS IS.
3941
required: true
4042
- type: textarea
@@ -45,19 +47,19 @@ body:
4547
label: Example Code
4648
description: |
4749
Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
48-
50+
4951
If a maintainer can copy it, run it, and see it right away, there's a much higher chance that you'll be able to get help.
50-
52+
5153
**Important!**
52-
54+
55+
* Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
56+
* Reduce your code to the minimum required to reproduce the issue if possible. This makes it much easier for others to help you.
5357
* Use code tags (e.g., ```python ... ```) to correctly [format your code](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting).
5458
* INCLUDE the language label (e.g. `python`) after the first three backticks to enable syntax highlighting. (e.g., ```python rather than ```).
55-
* Reduce your code to the minimum required to reproduce the issue if possible. This makes it much easier for others to help you.
56-
* Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
5759
5860
placeholder: |
5961
The following code:
60-
62+
6163
```python
6264
from langchain_core.runnables import RunnableLambda
6365
@@ -99,16 +101,18 @@ body:
99101
Please share your system info with us. Do NOT skip this step and please don't trim
100102
the output. Most users don't include enough information here and it makes it harder
101103
for us to help you.
102-
104+
103105
Run the following command in your terminal and paste the output here:
104-
105-
python -m langchain_core.sys_info
106-
106+
107+
`python -m langchain_core.sys_info`
108+
107109
or if you have an existing python interpreter running:
108-
110+
111+
```python
109112
from langchain_core import sys_info
110113
sys_info.print_sys_info()
111-
114+
```
115+
112116
alternatively, put the entire output of `pip freeze` here.
113117
placeholder: |
114118
python -m langchain_core.sys_info

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
blank_issues_enabled: false
22
version: 2.1
33
contact_links:
4-
- name: 🤔 Question
5-
about: Ask a question in the LangChain forums
6-
url: https://forum.langchain.com/c/help/langchain/14
7-
- name: Feature Request
8-
url: https://www.github.com/langchain-ai/langchain/discussions/categories/ideas
9-
about: Suggest a feature or an idea
10-
- name: Show and tell
11-
about: Show what you built with LangChain
12-
url: https://www.github.com/langchain-ai/langchain/discussions/categories/show-and-tell
4+
- name: LangChain Forum
5+
url: https://forum.langchain.com/
6+
about: General community discussions, support, and feature requests

0 commit comments

Comments
 (0)