CI: Update issue template (#16517)

More updates to the ISSUE template
pull/16519/head
Eugene Yurtsev 8 months ago committed by GitHub
parent 0b740ebd49
commit dfd94fb2f0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -1,5 +1,5 @@
name: "\U0001F41B Bug Report" name: "\U0001F41B Bug Report"
description: Submit a bug report to help us improve LangChain. To report a security issue, please instead use the security option below. 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.
labels: ["02 Bug Report"] labels: ["02 Bug Report"]
body: body:
- type: markdown - type: markdown
@ -7,6 +7,11 @@ body:
value: > value: >
Thank you for taking the time to file a bug report. Thank you for taking the time to file a bug report.
Use this to report bugs in LangChain.
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)
to ask for help with your issue.
Relevant links to check before filing a bug report to see if your issue has already been reported, fixed or Relevant links to check before filing a bug report to see if your issue has already been reported, fixed or
if there's another way to solve your problem: if there's another way to solve your problem:
@ -14,7 +19,8 @@ body:
[API Reference](https://api.python.langchain.com/en/stable/), [API Reference](https://api.python.langchain.com/en/stable/),
[GitHub search](https://github.com/langchain-ai/langchain), [GitHub search](https://github.com/langchain-ai/langchain),
[LangChain Github Discussions](https://github.com/langchain-ai/langchain/discussions), [LangChain Github Discussions](https://github.com/langchain-ai/langchain/discussions),
[LangChain Github Issues](https://github.com/langchain-ai/langchain/issues?q=is%3Aissue) [LangChain Github Issues](https://github.com/langchain-ai/langchain/issues?q=is%3Aissue),
[LangChain ChatBot](https://chat.langchain.com/)
- type: checkboxes - type: checkboxes
id: checks id: checks
attributes: attributes:
@ -27,6 +33,8 @@ body:
required: true required: true
- label: I used the GitHub search to find a similar question and didn't find it. - label: I used the GitHub search to find a similar question and didn't find it.
required: true required: true
- label: I am sure that this is a bug in LangChain rather than my code.
required: true
- type: textarea - type: textarea
id: reproduction id: reproduction
validations: validations:
@ -38,10 +46,12 @@ body:
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. 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.
If you're including an error message, please include the full stack trace not just the last error. **Important!**
**Important!** Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting * 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).
Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code. * INCLUDE the language label (e.g. `python`) after the first three backticks to enable syntax highlighting. (e.g., ```python rather than ```).
* Reduce your code to the minimum required to reproduce the issue if possible. This makes it much easier for others to help you.
* Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
placeholder: | placeholder: |
The following code: The following code:
@ -55,9 +65,16 @@ body:
chain = RunnableLambda(bad_code) chain = RunnableLambda(bad_code)
chain.invoke('Hello!') chain.invoke('Hello!')
``` ```
- type: textarea
Include both the error and the full stack trace if reporting an exception! id: error
validations:
required: false
attributes:
label: Error Message and Stack Trace (if applicable)
description: |
If you are reporting an error, please include the full error message and stack trace.
placeholder: |
Exception + full stack trace
- type: textarea - type: textarea
id: description id: description
attributes: attributes:
@ -76,28 +93,26 @@ body:
id: system-info id: system-info
attributes: attributes:
label: System Info label: System Info
description: Please share your system info with us. description: |
Please share your system info with us.
"pip freeze | grep langchain"
platform (windows / linux / mac)
python version
OR if you're on a recent version of langchain-core you can paste the output of:
python -m langchain_core.sys_info
placeholder: | placeholder: |
"pip freeze | grep langchain" "pip freeze | grep langchain"
platform platform
python version python version
Alternatively, if you're on a recent version of langchain-core you can paste the output of:
python -m langchain_core.sys_info
These will only surface LangChain packages, 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 `pip freeze`).
validations: validations:
required: true required: true
- type: checkboxes
id: related-components
attributes:
label: Related Components
description: "Select the components related to the issue (if applicable):"
options:
- label: "LLMs/Chat Models"
- label: "Embedding Models"
- label: "Prompts / Prompt Templates / Prompt Selectors"
- label: "Output Parsers"
- label: "Document Loaders"
- label: "Vector Stores / Retrievers"
- label: "Memory"
- label: "Agents / Agent Executors"
- label: "Tools / Toolkits"
- label: "Chains"
- label: "Callbacks/Tracing"
- label: "Async"

Loading…
Cancel
Save