mirror of
https://github.com/hwchase17/langchain
synced 2024-10-31 15:20:26 +00:00
dfd94fb2f0
More updates to the ISSUE template
119 lines
4.9 KiB
YAML
119 lines
4.9 KiB
YAML
name: "\U0001F41B Bug Report"
|
|
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"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: >
|
|
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
|
|
if there's another way to solve your problem:
|
|
|
|
[LangChain documentation with the integrated search](https://python.langchain.com/docs/get_started/introduction),
|
|
[API Reference](https://api.python.langchain.com/en/stable/),
|
|
[GitHub search](https://github.com/langchain-ai/langchain),
|
|
[LangChain Github Discussions](https://github.com/langchain-ai/langchain/discussions),
|
|
[LangChain Github Issues](https://github.com/langchain-ai/langchain/issues?q=is%3Aissue),
|
|
[LangChain ChatBot](https://chat.langchain.com/)
|
|
- type: checkboxes
|
|
id: checks
|
|
attributes:
|
|
label: Checked other resources
|
|
description: Please confirm and check all the following options.
|
|
options:
|
|
- label: I added a very descriptive title to this issue.
|
|
required: true
|
|
- label: I searched the LangChain documentation with the integrated search.
|
|
required: true
|
|
- label: I used the GitHub search to find a similar question and didn't find it.
|
|
required: true
|
|
- label: I am sure that this is a bug in LangChain rather than my code.
|
|
required: true
|
|
- type: textarea
|
|
id: reproduction
|
|
validations:
|
|
required: true
|
|
attributes:
|
|
label: Example Code
|
|
description: |
|
|
Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
|
|
|
|
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.
|
|
|
|
**Important!**
|
|
|
|
* 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).
|
|
* 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: |
|
|
The following code:
|
|
|
|
```python
|
|
from langchain_core.runnables import RunnableLambda
|
|
|
|
def bad_code(inputs) -> int:
|
|
raise NotImplementedError('For demo purpose')
|
|
|
|
chain = RunnableLambda(bad_code)
|
|
chain.invoke('Hello!')
|
|
```
|
|
- type: textarea
|
|
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
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: |
|
|
What is the problem, question, or error?
|
|
|
|
Write a short description telling what you are doing, what you expect to happen, and what is currently happening.
|
|
placeholder: |
|
|
* I'm trying to use the `langchain` library to do X.
|
|
* I expect to see Y.
|
|
* Instead, it does Z.
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
id: system-info
|
|
attributes:
|
|
label: System Info
|
|
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: |
|
|
"pip freeze | grep langchain"
|
|
platform
|
|
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:
|
|
required: true
|