diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 7496543864..c9c9c15e9d 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -8,57 +8,66 @@ body: Thank you for taking the time to file a bug report. Before creating a new issue, please make sure to take a few moments to check the issue tracker for existing issues about the bug. - - - type: textarea - id: system-info + - type: checkboxes + id: checks attributes: - label: System Info - description: Please share your system info with us. - placeholder: LangChain version, platform, python version, ... + 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 + - 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. + + If you're including an error message, please include the full stack trace not just the last error. + + 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 + 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 import .... + # Some code goes here + ``` + + Error / Full Stack trace: - type: textarea - id: who-can-help + id: description attributes: - label: Who can help? + label: Description description: | - Your issue will be replied to more quickly if you can figure out the right person to tag with @ - If you know how to use git blame, that is the easiest way, otherwise, here is a rough guide of **who to tag**. - - The core maintainers strive to read all issues, but tagging them will help them prioritize. - - Please tag fewer than 3 people. - - @hwchase17 - project lead - - Tracing / Callbacks - - @agola11 - - Async - - @agola11 - - DataLoader Abstractions - - @eyurtsev + What is the problem, question, or error? - LLM/Chat Wrappers - - @hwchase17 - - @agola11 - - Tools / Toolkits - - ... - - placeholder: "@Username ..." - - - type: checkboxes - id: information-scripts-examples + 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: Information - description: "The problem arises when using:" - options: - - label: "The official example notebooks/scripts" - - label: "My own modified scripts" - + label: System Info + description: Please share your system info with us. + placeholder: `pip freeze | grep langchain`, platform, python version + validations: + required: true - type: checkboxes id: related-components attributes: @@ -77,30 +86,3 @@ body: - label: "Chains" - label: "Callbacks/Tracing" - label: "Async" - - - type: textarea - id: reproduction - validations: - required: true - attributes: - label: Reproduction - description: | - Please provide a [code sample](https://stackoverflow.com/help/minimal-reproducible-example) that reproduces the problem you ran into. It can be a Colab link or just a code snippet. - If you have code snippets, error messages, stack traces please provide them here as well. - 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 - Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code. - - placeholder: | - Steps to reproduce the behavior: - - 1. - 2. - 3. - - - type: textarea - id: expected-behavior - validations: - required: true - attributes: - label: Expected behavior - description: "A clear and concise description of what you would expect to happen." diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml deleted file mode 100644 index 88ad5a3446..0000000000 --- a/.github/ISSUE_TEMPLATE/other.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Other Issue -description: Raise an issue that wouldn't be covered by the other templates. -title: "Issue: " -labels: [04 - Other] - -body: - - type: textarea - attributes: - label: "Issue you'd like to raise." - description: > - Please describe the issue you'd like to raise as clearly as possible. - Make sure to include any relevant links or references. - - - type: textarea - attributes: - label: "Suggestion:" - description: > - Please outline a suggestion to improve the issue here.