From 81aa63eb923a07da1e741ad7ae1c7899ea84e663 Mon Sep 17 00:00:00 2001 From: Frazer Smith Date: Fri, 3 Sep 2021 19:42:25 +0000 Subject: [PATCH] chore(.github): use new YAML configured GitHub issue forms (#35) * chore(.github): use new YAML configured GitHub issue forms * chore(.github): change pull_request_template.md location * chore(.github): fix label casing --- .github/ISSUE_TEMPLATE/bug_report.md | 38 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 79 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 31 ++++++++ .../pull_request_template.md | 0 5 files changed, 110 insertions(+), 57 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml rename .github/{ISSUE_TEMPLATE => }/PULL_REQUEST_TEMPLATE/pull_request_template.md (100%) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 4d2c244..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "" -labels: bug -assignees: "" ---- - -### Describe the bug - -A clear and concise description of what the bug is. - -### To Reproduce - -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -### Expected behavior - -A clear and concise description of what you expected to happen. - -### Screenshots - -If applicable, add screenshots to help explain your problem. - -### Desktop (please complete the following information) - -- OS: [e.g. Windows] -- Version [e.g. Windows 10] -- Node.js Version [e.g. NodeJS v14.8.0] - -### Additional context - -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..efa7706 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,79 @@ +name: 🐛 Bug Report +description: File a bug report and help us improve +labels: [bug] + +body: + - type: markdown + attributes: + value: | + Thanks for filing a bug report, any help is greatly appreciated! + + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + options: + - label: I have written a descriptive issue title + required: true + - label: | + I have searched existing issues to ensure it has not already been reported + required: true + - label: | + I agree to follow the [Code of Conduct](../../CODE_OF_CONDUCT.md) that this project adheres to + required: true + + - type: input + id: version + attributes: + label: API/app/plugin version + placeholder: 1.x.x + + - type: input + id: node-version + attributes: + label: Node.js version + placeholder: 14.x + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating system + options: + - Linux + - macOS + - Windows + validations: + required: true + + - type: input + id: os-version + attributes: + label: Operating system version (i.e. 20.04, 11.3, 10) + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: | + List of steps, sample code, or a link to code or a project that reproduces the behaviour. + Make sure you place a stack trace inside a [code (```) block](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) to avoid linking unrelated issues. + validations: + required: true + + - type: textarea + id: expected-behaviour + attributes: + label: Expected Behaviour + description: A clear and concise description of what you expected to happen. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index d883b8f..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: enhancement -assignees: "" ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..617b490 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,31 @@ +name: 🚀 Feature Request +description: Submit a proposal for a new feature +labels: [feature] + +body: + - type: markdown + attributes: + value: | + Thanks for making a feature request, new ideas are greatly appreciated! + + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + options: + - label: I have written a descriptive title + required: true + - label: | + I have searched existing feature requests to ensure it has not already been proposed + required: true + - label: | + I agree to follow the [Code of Conduct](../../CODE_OF_CONDUCT.md) that this project adheres to + required: true + + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what the feature is, and what it would solve. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md similarity index 100% rename from .github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/PULL_REQUEST_TEMPLATE/pull_request_template.md