From 4510b3615567a04fa6247b86dcb522cb99f57767 Mon Sep 17 00:00:00 2001 From: Richard Zampieri Date: Tue, 22 Oct 2024 11:40:18 -0700 Subject: [PATCH] cicd: add bug and feature request form in the project (#1587) * cicd: add bug and feature request form in the project * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: notaphplover * feat: add config to avoid skip issue templates --------- Co-authored-by: notaphplover Co-authored-by: Richard Zampieri --- .github/ISSUE_TEMPLATE/bug_report.yml | 103 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 73 +++++++++++++++ 3 files changed, 177 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..bfe3a09b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,103 @@ +name: "\U0001F41B Bug Report" +description: "If something isn't working as expected \U0001F914" +labels: ["needs triage"] +body: + - type: markdown + attributes: + value: | + ## :warning: We use GitHub Issues to track bug reports and feature requests + + If you are not sure that your issue is a bug, you could: + + - use our [Discord community](https://discord.gg/jXcMagAPnm) + - use [StackOverflow using the tag `inversifyjs`](https://stackoverflow.com/questions/tagged/inversifyjs) + + **NOTE:** You don't need to answer questions that you know that aren't relevant. + + --- + + - type: checkboxes + attributes: + label: "Is there an existing issue for this?" + description: "Please search [here](https://github.com/inversify/InversifyJS/issues) to see if an issue already exists for the bug you encountered" + options: + - label: "I have searched the existing issues" + required: true + + - type: textarea + validations: + required: true + attributes: + label: "Current behavior" + description: "How the issue manifests?" + + - type: textarea + attributes: + label: "Steps to reproduce" + description: | + How the issue manifests? + You could leave this blank if you can't reproduce it, but please provide as much information as possible + placeholder: | + 1. `npm ci` + 2. `npm start:dev` + 3. See error... + + - type: textarea + validations: + required: true + attributes: + label: "Expected behavior" + description: "A clear and concise description of what you expected to happened (or code)" + + - type: textarea + validations: + required: false + attributes: + label: "Possible solution" + description: "If you have a suggestion on how to fix the bug" + + - type: markdown + attributes: + value: | + --- + + + - type: input + validations: + required: true + attributes: + label: "Package version" + description: | + Which version of `inversify` are you using? + placeholder: "6.0.1" + + - type: input + attributes: + label: "Node.js version" + description: "Which version of Node.js are you using?" + placeholder: "18.0.0" + + - type: checkboxes + attributes: + label: "In which operating systems have you tested?" + options: + - label: macOS + - label: Windows + - label: Linux + + - type: markdown + attributes: + value: | + --- + + - type: textarea + attributes: + label: "Stack trace" + description: "If you have a stack trace, please include it here" + + - type: textarea + attributes: + label: "Other" + description: | + Anything else relevant? eg: Logs, OS version, IDE, package manager, etc. + **Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ec4bb386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ 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..146bb007 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,73 @@ +name: "\U0001F680 Community Ideas" +description: "I have an idea or proposal \U0001F4A1!" +labels: ["needs triage"] +assignees: + - "rsaz" +body: + - type: markdown + attributes: + value: | + ## :heart: We would love to hear your ideas and proposals + + Suggest an idea for a specific feature, product, process, anything you wish to propose to the community for comment and discussion. + + **NOTE:** If your idea is approved after discussion, you will be asked to provide more technical information until we get an issue to implement it. + + --- + + - type: checkboxes + attributes: + label: "Is there an existing proposal similar to this?" + description: "Please make sure that your idea is not already proposed otherwise you will be asked to comment on the existing proposal" + options: + - label: "I have searched the existing proposals" + required: true + + - type: textarea + validations: + required: true + attributes: + label: "What are you proposing?" + description: "In a few sentences, describe your idea or proposal" + placeholder: | + My idea is ... + + - type: textarea + validations: + required: true + attributes: + label: "Is there any specific group of users that will benefit from this?" + description: "Highlight any research, proposals, requests or anecdotes that signal this is the right thing to build. Include links to GitHub Issues, Forums, Stack Overflow, Twitter, Etc" + placeholder: | + I have seen ... + + - type: textarea + validations: + required: true + attributes: + label: "What problems are you trying to solve?" + description: "Describe the problems that this idea or proposal will solve" + placeholder: | + I am trying to solve ... + + - type: textarea + validations: + required: true + attributes: + label: "Do you have any references or examples that can illustrate your idea?" + description: "If you have any references or examples that can illustrate your idea, who is using it, and how it is being used, please share them here" + placeholder: | + I have seen ... + + - type: dropdown + id: idea-type + validations: + required: true + attributes: + label: "What type of idea is this?" + description: "Select the type of idea that this is" + multiple: false + options: + - "Innovation: No similar idea exists" + - "Improvement of existing idea: Similar idea exists but this is an improvement" + - "Copy of existing idea: Similar idea exists and this is a copy"