forked from langchain-ai/langchainjs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci[minor]: Add issue & discussion templates (langchain-ai#4577)
* ci[minor]: Add issue & discussion templates * last nit * Apply suggestions from code review
- Loading branch information
1 parent
2a5adf5
commit 0897863
Showing
6 changed files
with
361 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| labels: [idea] | ||
| body: | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: Checked | ||
| description: Please confirm and check all the following options. | ||
| options: | ||
| - label: I searched existing ideas and did not find a similar one | ||
| required: true | ||
| - label: I added a very descriptive title | ||
| required: true | ||
| - label: I've clearly described the feature request and motivation for it | ||
| required: true | ||
| - 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: proposal | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: Proposal (If applicable) | ||
| description: | | ||
| If you would like to propose a solution, please describe it here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| labels: [Question] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for your interest in LangChain.js 🦜️🔗! | ||
| Please follow these instructions, fill every question, and do every step. 🙏 | ||
| We're asking for this because answering questions and solving problems in GitHub takes a lot of time -- | ||
| this is time that we cannot spend on adding new features, fixing bugs, writing documentation or reviewing pull requests. | ||
| By asking questions in a structured way (following this) it will be much easier for us to help you. | ||
| There's a high chance that by following this process, you'll find the solution on your own, eliminating the need to submit a question and wait for an answer. 😎 | ||
| As there are many questions submitted every day, we will **DISCARD** and close the incomplete ones. | ||
| That will allow us (and others) to focus on helping people like you that follow the whole process. 🤓 | ||
| Relevant links to check before opening a question to see if your question has already been answered, fixed or | ||
| if there's another way to solve your problem: | ||
| [LangChain.js documentation with the integrated search](https://js.langchain.com/docs/get_started/introduction), | ||
| [API Reference](https://api.js.langchain.com/), | ||
| [GitHub search](https://github.com/langchain-ai/langchainjs), | ||
| [LangChain.js Github Discussions](https://github.com/langchain-ai/langchainjs/discussions), | ||
| [LangChain.js Github Issues](https://github.com/langchain-ai/langchainjs/issues?q=is%3Aissue), | ||
| [LangChain.js ChatBot](https://chatjs.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 question. | ||
| 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: checkboxes | ||
| id: help | ||
| attributes: | ||
| label: Commit to Help | ||
| description: | | ||
| After submitting this, I commit to one of: | ||
| * Read open questions until I find 2 where I can help someone and add a comment to help there. | ||
| * I already hit the "watch" button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future. | ||
| * Once my question is answered, I will mark the answer as "accepted". | ||
| options: | ||
| - label: I commit to help with one of those options 👆 | ||
| required: true | ||
| - type: textarea | ||
| id: example | ||
| 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., ```typescript ... ```) 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. `typescript`) after the first three backticks to enable syntax highlighting. (e.g., ```typescript 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: | | ||
| import { RunnableLambda } from "@langchain/core/runnables" | ||
| const badCode = (inputs: Record<string, any>) => { | ||
| throw new Error('For demo purposes'); | ||
| } | ||
| const chain = new RunnableLambda({ func: badCode }); | ||
| await chain.invoke({ input: 'Hello!' }); | ||
| render: typescript | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: | | ||
| What is the problem, question, or error? | ||
| Write a short description explaining 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. | ||
| "yarn info langchain" | ||
| platform (windows / linux / mac) | ||
| Node version | ||
| yarn version | ||
| placeholder: | | ||
| "yarn info langchain" | ||
| platform | ||
| Node version | ||
| yarn version | ||
| These will only surface LangChain.js 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 `yarn info`). | ||
| validations: | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| name: "\U0001F41B Bug Report" | ||
| description: Report a bug in LangChain.js. 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.js. | ||
| If you're not certain that your issue is due to a bug in LangChain, please use [GitHub Discussions](https://github.com/langchain-ai/langchainjs/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.js documentation with the integrated search](https://js.langchain.com/docs/get_started/introduction), | ||
| [API Reference](https://api.js.langchain.com/), | ||
| [GitHub search](https://github.com/langchain-ai/langchainjs), | ||
| [LangChain.js Github Discussions](https://github.com/langchain-ai/langchainjs/discussions), | ||
| [LangChain.js Github Issues](https://github.com/langchain-ai/langchainjs/issues?q=is%3Aissue), | ||
| [LangChain.js ChatBot](https://chatjs.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.js 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.js rather than my code. | ||
| required: true | ||
| - label: The bug is not resolved by updating to the latest stable version of LangChain (or the specific integration package). | ||
| 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., ```typescript ... ```) 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. `typescript`) after the first three backticks to enable syntax highlighting. (e.g., ```typescript 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: | ||
| ```typescript | ||
| import { RunnableLambda } from "@langchain/core/runnables" | ||
| const badCode = (inputs: Record<string, any>) => { | ||
| throw new Error('For demo purposes'); | ||
| } | ||
| const chain = new RunnableLambda({ func: badCode }); | ||
| await chain.invoke({ input: '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. | ||
| "yarn info langchain" | ||
| platform (windows / linux / mac) | ||
| Node version | ||
| yarn version | ||
| placeholder: | | ||
| "yarn info langchain" | ||
| platform | ||
| Node version | ||
| yarn version | ||
| These will only surface LangChain.js 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 `yarn info`). | ||
| validations: | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| blank_issues_enabled: false | ||
| version: 2.1 | ||
| contact_links: | ||
| - name: 🤔 Question or Problem | ||
| about: Ask a question or ask about a problem in GitHub Discussions. | ||
| url: https://www.github.com/langchain-ai/langchainjs/discussions/categories/q-a | ||
| - name: Discord | ||
| url: https://discord.gg/6adMQxSpJS | ||
| about: General community discussions | ||
| - name: Feature Request | ||
| url: https://www.github.com/langchain-ai/langchainjs/discussions/categories/ideas | ||
| about: Suggest a feature or an idea | ||
| - name: Show and tell | ||
| about: Show what you built with LangChain | ||
| url: https://www.github.com/langchain-ai/langchainjs/discussions/categories/show-and-tell |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| name: Documentation | ||
| description: Report an issue related to the LangChain.js documentation. | ||
| title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>" | ||
| labels: [03 - Documentation] | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: > | ||
| Thank you for taking the time to report an issue in the documentation. | ||
| Only report issues with documentation here, explain if there are | ||
| any missing topics or if you found a mistake in the documentation. | ||
| Do **NOT** use this to ask usage questions or reporting issues with your code. | ||
| If you have usage questions or need help solving some problem, | ||
| please use [GitHub Discussions](https://github.com/langchain-ai/langchainjs/discussions). | ||
| If you're in the wrong place, here are some helpful links to find a better | ||
| place to ask your question: | ||
| [LangChain.js documentation with the integrated search](https://js.langchain.com/docs/get_started/introduction), | ||
| [API Reference](https://api.js.langchain.com/), | ||
| [GitHub search](https://github.com/langchain-ai/langchainjs), | ||
| [LangChain.js Github Discussions](https://github.com/langchain-ai/langchainjs/discussions), | ||
| [LangChain.js Github Issues](https://github.com/langchain-ai/langchainjs/issues?q=is%3Aissue), | ||
| [LangChain.js ChatBot](https://chatjs.langchain.com/) | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: Checklist | ||
| description: Please confirm and check all the following options. | ||
| options: | ||
| - label: I added a very descriptive title to this issue. | ||
| required: true | ||
| - label: I included a link to the documentation page I am referring to (if applicable). | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: "Issue with current documentation:" | ||
| description: > | ||
| Please make sure to leave a reference to the document/code you're | ||
| referring to. Feel free to include names of classes, functions, methods | ||
| or concepts you'd like to see documented more. | ||
| - 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| name: 🔒 Privileged | ||
| description: You are a LangChain maintainer, or was asked directly by a maintainer to create an issue here. If not, check the other options. | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for your interest in LangChain.js! 🚀 | ||
| If you are not a LangChain maintainer or were not asked directly by a maintainer to create an issue, then please start the conversation in a [Question in GitHub Discussions](https://github.com/langchain-ai/langchainjs/discussions/categories/q-a) instead. | ||
| You are a LangChain maintainer if you maintain any of the packages inside of the LangChain repository | ||
| or are a regular contributor to LangChain with previous merged pull requests. | ||
| - type: checkboxes | ||
| id: privileged | ||
| attributes: | ||
| label: Privileged issue | ||
| description: Confirm that you are allowed to create an issue here. | ||
| options: | ||
| - label: I am a LangChain maintainer, or was asked directly by a LangChain maintainer to create an issue here. | ||
| required: true | ||
| - type: textarea | ||
| id: content | ||
| attributes: | ||
| label: Issue Content | ||
| description: Add the content of the issue here. |