Skip to content

Commit 27c9e81

Browse files
dqbddqbd
authored
chore: add issues template (#1339)
1 parent 4a43c27 commit 27c9e81

File tree

2 files changed

+133
-0
lines changed

2 files changed

+133
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
name: "\U0001F41B Bug Report"
2+
description: Report a bug in LangGraph.js. To report a security issue, please instead use the security option below. For questions, please use the GitHub Discussions.
3+
labels: ["02 Bug Report"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Thank you for taking the time to file a bug report.
9+
10+
Use this to report bugs in LangGraph.js.
11+
12+
If you're not certain that your issue is due to a bug in LangGraph.js, please use [GitHub Discussions](https://github.com/langchain-ai/langgraphjs/discussions)
13+
to ask for help with your issue.
14+
15+
Relevant links to check before filing a bug report to see if your issue has already been reported, fixed or
16+
if there's another way to solve your problem:
17+
18+
[LangGraph.js documentation with the integrated search](https://langchain-ai.github.io/langgraphjs/),
19+
[API Reference](https://langchain-ai.github.io/langgraphjs/reference/),
20+
[LangChain Forum](https://forum.langchain.com/)
21+
[GitHub search](https://github.com/langchain-ai/langgraphjs),
22+
[LangGraph.js Github Discussions](https://github.com/langchain-ai/langgraphjs/discussions),
23+
[LangGraph.js Github Issues](https://github.com/langchain-ai/langgraphjs/issues?q=is%3Aissue),
24+
- type: checkboxes
25+
id: checks
26+
attributes:
27+
label: Checked other resources
28+
description: Please confirm and check all the following options.
29+
options:
30+
- label: I added a very descriptive title to this issue.
31+
required: true
32+
- label: I searched the LangGraph.js documentation with the integrated search.
33+
required: true
34+
- label: I used the GitHub search to find a similar question and didn't find it.
35+
required: true
36+
- label: I am sure that this is a bug in LangGraph.js rather than my code.
37+
required: true
38+
- label: The bug is not resolved by updating to the latest stable version of LangGraph (or the specific integration package).
39+
required: true
40+
- type: textarea
41+
id: reproduction
42+
validations:
43+
required: true
44+
attributes:
45+
label: Example Code
46+
description: |
47+
Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
48+
49+
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+
51+
**Important!**
52+
53+
* Use code tags (e.g., ```typescript ... ```) to correctly [format your code](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting).
54+
* INCLUDE the language label (e.g. `typescript`) after the first three backticks to enable syntax highlighting. (e.g., ```typescript 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.
57+
58+
placeholder: |
59+
The following code:
60+
61+
```typescript
62+
import { StateGraph, Annotation } from "@langchain/langgraph";
63+
64+
const graph = new StateGraph(
65+
Annotation.Root({ messages: Annotation<string[]> }),
66+
)
67+
.addNode("node", (state) => {
68+
throw new Error("Invalid code");
69+
return { messages: [...state.messages, "Hello, world!"] };
70+
})
71+
.compile();
72+
73+
console.log(await graph.invoke({ messages: ["Hello, world!"] }));
74+
```
75+
- type: textarea
76+
id: error
77+
validations:
78+
required: false
79+
attributes:
80+
label: Error Message and Stack Trace (if applicable)
81+
description: |
82+
If you are reporting an error, please include the full error message and stack trace.
83+
placeholder: |
84+
Error + full stack trace
85+
- type: textarea
86+
id: description
87+
attributes:
88+
label: Description
89+
description: |
90+
What is the problem, question, or error?
91+
92+
Write a short description telling what you are doing, what you expect to happen, and what is currently happening.
93+
placeholder: |
94+
* I'm trying to use the `@langchain/langgraph` library to do X.
95+
* I expect to see Y.
96+
* Instead, it does Z.
97+
validations:
98+
required: true
99+
- type: textarea
100+
id: system-info
101+
attributes:
102+
label: System Info
103+
description: |
104+
Please share your system info with us.
105+
106+
Package Info (`npm ls` / `yarn info` / `pnpm list`)
107+
Platform (Windows / Linux / Mac)
108+
Node version
109+
Package Manager (Yarn / Npm / Pnpm / Bun) and version of the package manager
110+
placeholder: |
111+
Package Info (`npm ls` / `yarn info` / `pnpm list`)
112+
Platform (Windows / Linux / Mac)
113+
Node version
114+
Package Manager (Yarn / Npm / Pnpm / Bun) and version of the package manager
115+
116+
Don't forget to include any other relevant packages you're using (if you're not sure what's relevant, you can paste the entire output of `npm ls` / `yarn info` / `pnpm list`).
117+
validations:
118+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
blank_issues_enabled: false
2+
version: 2.1
3+
contact_links:
4+
- name: 🤔 Question or Problem
5+
about: Ask a question or ask about a problem in GitHub Discussions.
6+
url: https://www.github.com/langchain-ai/langgraphjs/discussions/categories/q-a
7+
- name: Feature Request
8+
url: https://www.github.com/langchain-ai/langgraphjs/discussions/categories/ideas
9+
about: Suggest a feature or an idea
10+
- name: Show and tell
11+
about: Show what you built with LangGraph
12+
url: https://www.github.com/langchain-ai/langgraphjs/discussions/categories/show-and-tell
13+
- name: LangChain Forum
14+
url: https://forum.langchain.com/
15+
about: General community discussions and support

0 commit comments

Comments
 (0)