From 953a88015d9389afa8843f3fcfcb0f916ab021b5 Mon Sep 17 00:00:00 2001 From: "Micael Levi (lab)" Date: Sat, 2 Oct 2021 11:02:17 -0400 Subject: [PATCH] chore(): migrate to github issues forms --- .github/ISSUE_TEMPLATE.md | 38 -------- .github/ISSUE_TEMPLATE/Bug_report.yml | 106 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.yml | 52 ++++++++++ .github/ISSUE_TEMPLATE/Regression.yml | 78 +++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 ++ 5 files changed, 243 insertions(+), 38 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/Regression.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index b06c11262..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,38 +0,0 @@ - - -## I'm submitting a... - -

-[ ] Regression 
-[ ] Bug report
-[ ] Feature request
-[ ] Documentation issue or request
-[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.
-
- -## Current behavior - - - -## Expected behavior - - - -## Minimal reproduction of the problem with instructions - - -## What is the motivation / use case for changing the behavior? - - - -## Environment - -``` - -``` \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Bug_report.yml b/.github/ISSUE_TEMPLATE/Bug_report.yml new file mode 100644 index 000000000..db0e09143 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.yml @@ -0,0 +1,106 @@ +name: "\U0001F41B Bug Report" +description: "If something isn't working as expected \U0001F914" +labels: ["needs triage", "bug"] +body: + - type: markdown + attributes: + value: | + ## :warning: We use GitHub Issues to track bug reports, feature requests and regressions + + If you are not sure that your issue is a bug, you could: + + - use our [Discord community](https://discord.gg/NestJS) + - use [StackOverflow using the tag `nestjs`](https://stackoverflow.com/questions/tagged/nestjs) + - If it's just a quick question you can ping [our Twitter](https://twitter.com/nestframework) + + **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](./?q=is%3Aissue) 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: input + validations: + required: true + attributes: + label: "Minimum reproduction code" + description: "An URL to some git repository or gist that reproduces this issue. [Wtf is a minimum reproduction?](https://jmcdo29.github.io/wtf-is-a-minimum-reproduction)" + placeholder: "https://github.com/..." + + - type: textarea + attributes: + label: "Steps to reproduce" + description: | + How the issue manifests? + You could leave this blank if you alread write this in your reproduction code/repo + placeholder: | + 1. `npm i` + 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 happend (or code)" + + - type: markdown + attributes: + value: | + --- + + - type: input + validations: + required: true + attributes: + label: "Package version" + description: | + Which version of `@nestjs/cli` are you using? + **Tip**: Make sure that all of yours `@nestjs/*` dependencies are in sync! + placeholder: "8.1.3" + + - type: input + attributes: + label: "NestJS version" + description: "Which version of `@nestjs/core` are you using?" + placeholder: "8.1.3" + + - type: input + attributes: + label: "Node.js version" + description: "Which version of Node.js are you using?" + placeholder: "14.17.6" + + - 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: "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/Feature_request.yml b/.github/ISSUE_TEMPLATE/Feature_request.yml new file mode 100644 index 000000000..367b778ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.yml @@ -0,0 +1,52 @@ +name: "\U0001F680 Feature Request" +description: "I have a suggestion \U0001F63B!" +labels: ["feature"] +body: + - type: markdown + attributes: + value: | + ## :warning: We use GitHub Issues to track bug reports, feature requests and regressions + + If you are not sure that your issue is a bug, you could: + + - use our [Discord community](https://discord.gg/NestJS) + - use [StackOverflow using the tag `nestjs`](https://stackoverflow.com/questions/tagged/nestjs) + - If it's just a quick question you can ping [our Twitter](https://twitter.com/nestframework) + + --- + + - type: checkboxes + attributes: + label: "Is there an existing issue that is already proposing this?" + description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the feature you are requesting" + options: + - label: "I have searched the existing issues" + required: true + + - type: textarea + validations: + required: true + attributes: + label: "Is your feature request related to a problem? Please describe it" + description: "A clear and concise description of what the problem is" + placeholder: | + I have an issue when ... + + - type: textarea + validations: + required: true + attributes: + label: "Describe the solution you'd like" + description: "A clear and concise description of what you want to happen. Add any considered drawbacks" + + - type: textarea + attributes: + label: "Teachability, documentation, adoption, migration strategy" + description: "If you can, explain how users will be able to use this and possibly write out a version the docs. Maybe a screenshot or design?" + + - type: textarea + validations: + required: true + attributes: + label: "What is the motivation / use case for changing the behavior?" + description: "Describe the motivation or the concrete use case" diff --git a/.github/ISSUE_TEMPLATE/Regression.yml b/.github/ISSUE_TEMPLATE/Regression.yml new file mode 100644 index 000000000..52069d2c6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Regression.yml @@ -0,0 +1,78 @@ +name: "\U0001F4A5 Regression" +description: "Report an unexpected behavior while upgrading your Nest application!" +labels: ["needs triage"] +body: + - type: markdown + attributes: + value: | + ## :warning: We use GitHub Issues to track bug reports, feature requests and regressions + + If you are not sure that your issue is a bug, you could: + + - use our [Discord community](https://discord.gg/NestJS) + - use [StackOverflow using the tag `nestjs`](https://stackoverflow.com/questions/tagged/nestjs) + - If it's just a quick question you can ping [our Twitter](https://twitter.com/nestframework) + + **NOTE:** You don't need to answer questions that you know that aren't relevant. + + --- + + - type: checkboxes + attributes: + label: "Did you read the migration guide?" + description: "Check out the [migration guide here](https://docs.nestjs.com/migration-guide)!" + options: + - label: "I have read the whole migration guide" + required: false + + - type: checkboxes + attributes: + label: "Is there an existing issue that is already proposing this?" + description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the feature you are requesting" + options: + - label: "I have searched the existing issues" + required: true + + - type: input + attributes: + label: "Potential Commit/PR that introduced the regression" + description: "If you have time to investigate, what PR/date/version introduced this issue" + placeholder: "PR #123 or commit 5b3c4a4" + + - type: input + attributes: + label: "Versions" + description: "From which version of `@nestjs/cli` to which version you are upgrading" + placeholder: "8.1.0 -> 8.1.3" + + - type: textarea + validations: + required: true + attributes: + label: "Describe the regression" + description: "A clear and concise description of what the regression is" + + - type: textarea + attributes: + label: "Minimum reproduction code" + description: | + Please share a git repo, a gist, or step-by-step instructions. [Wtf is a minimum reproduction?](https://jmcdo29.github.io/wtf-is-a-minimum-reproduction) + **Tip:** If you leave a minimum repository, we will understand your issue faster! + value: | + ```ts + + ``` + + - type: textarea + validations: + required: true + attributes: + label: "Expected behavior" + description: "A clear and concise description of what you expected to happend (or code)" + + - 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 000000000..b080c8139 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +## To encourage contributors to use issue templates, we don't allow blank issues +blank_issues_enabled: false + +contact_links: + - name: "\u2753 Discord Community of NestJS" + url: "https://discord.gg/NestJS" + about: "Please ask support questions or discuss suggestions/enhancements here."