diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..27ba3771 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,106 @@ +name: "\U0001F41B Bug Report" +description: Submit a bug report to help us improve LangChain +labels: ["02 Bug Report"] +body: + - type: markdown + attributes: + value: > + 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 + attributes: + label: System Info + description: Please share your system info with us. + placeholder: LangChain version, platform, python version, ... + validations: + required: true + + - type: textarea + id: who-can-help + attributes: + label: Who can help? + 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 + + LLM/Chat Wrappers + - @hwchase17 + - @agola11 + + Tools / Toolkits + - @vowelparrot + + placeholder: "@Username ..." + + - type: checkboxes + id: information-scripts-examples + attributes: + label: Information + description: "The problem arises when using:" + options: + - label: "The official example notebooks/scripts" + - label: "My own modified scripts" + + - 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" + + - 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/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..7a40881c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: true +version: 2.1 +contact_links: + - name: Discord + url: https://discord.gg/6adMQxSpJS + about: General community discussions diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..61a3ad49 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,19 @@ +name: Documentation +description: Report an issue related to the LangChain documentation. +title: "DOC: " +labels: [03 - Documentation] + +body: +- type: textarea + attributes: + label: "Issue with current documentation:" + description: > + Please make sure to leave a reference to the document/code you're + referring to. + +- type: textarea + attributes: + label: "Idea or request for content:" + description: > + Please describe as clearly as possible what topics you think are missing + from the current documentation. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..24991581 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,30 @@ +name: "\U0001F680 Feature request" +description: Submit a proposal/request for a new LangChain feature +labels: ["02 Feature Request"] +body: + - type: textarea + id: feature-request + validations: + required: true + attributes: + label: Feature request + description: | + A clear and concise description of the feature proposal. Please provide links to any relevant GitHub repos, papers, or other resources if relevant. + + - type: textarea + id: motivation + validations: + required: true + attributes: + label: Motivation + description: | + Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too. + + - type: textarea + id: contribution + validations: + required: true + attributes: + label: Your contribution + description: | + Is there any way that you could help, e.g. by submitting a PR? Make sure to read the CONTRIBUTING.MD [readme](https://github.com/hwchase17/langchain/blob/master/.github/CONTRIBUTING.md) diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml new file mode 100644 index 00000000..88ad5a34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.yml @@ -0,0 +1,18 @@ +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.