From fd95e5d2ae2864fed01e425bfa88b0986e72da41 Mon Sep 17 00:00:00 2001 From: Nathan Knowler Date: Wed, 1 Dec 2021 23:23:00 -0600 Subject: [PATCH] Use forms for issue templates And disallow blank issues. Closes #5 (supersedes it) --- .github/ISSUE_TEMPLATE/bug_report.md | 39 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 93 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 26 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 56 +++++++++++++ 5 files changed, 150 insertions(+), 65 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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index f4b5ba0..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Bug report -about: Create a bug report ---- - - - -* [ ] I've read the [guidelines for Contributing to Roots Projects](https://github.com/roots/.github/blob/master/CONTRIBUTING.md) -* [ ] This request isn't a duplicate of an existing issue -* [ ] I've read the [docs](https://roots.io/documentation/) and followed them (if applicable) -* [ ] This is not a personal support request that should be posted on the [Roots Discourse](https://discourse.roots.io/) community - -## Description - -[Description of the issue] - -## Steps to reproduce - -1. [First step] -2. [Second step] -3. [and so on...] - -**Expected behavior:** [What you expect to happen] - -**Actual behavior:** [What actually happens] - -**Reproduces how often:** [What percentage of the time does it reproduce?] - -## Versions - -You can get this information from referencing `CHANGELOG.md`. Also, please include the OS and what version of the OS you're running. - -## Additional information - -Any additional information, configuration or data that might be necessary to reproduce the issue. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..712e421 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,93 @@ +name: Bug Report +description: Report a bug. Please provide enough information so that we can reproduce the problem. +title: "Bug: " +labels: [bug] + +body: + - type: markdown + attributes: + value: | + This form is for reporting technical issues. + If you have a question or you're looking for support, please visit [Roots Discourse](https://discourse.roots.io/). + + - type: checkboxes + id: terms + attributes: + options: + - label: I have read the [guidelines for Contributing to Roots Projects](https://github.com/roots/.github/blob/master/CONTRIBUTING.md) + required: true + - label: This request is not a duplicate of an existing issue + required: true + - label: I have read the [docs](https://roots.io/docs/) and followed them (if applicable) + required: true + - label: I have seached the [Roots Discourse](https://discourse.roots.io/) for answers and followed them (if applicable) + required: true + - label: This is not a personal support request that should be posted on the [Roots Discourse](https://discourse.roots.io/) community + required: true + + - type: textarea + id: description + attributes: + label: Description + value: | + #### What's wrong? + + #### What have you tried? + + #### What insights have you gained? + + #### Possible solutions + + #### Temporary workarounds + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps To Reproduce + description: | + Non-reproducible issues may be immediately closed as not actionable. + Please provide reproduction steps as detailed as possible. + value: | + 1. + 1. + 1. + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + placeholder: What did you expect to happen? + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + placeholder: What actually happens? + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant Log Output + description: Please copy and paste any relevant log output. + render: shell + + - type: input + id: versions + attributes: + label: Versions + description: You can get this information from referencing `CHANGELOG.md`. If you know, please provide the Git commit SHA. Also, please include the OS and what version of the OS you’re running. + validations: + required: true + + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 089dbe2..734e7f6 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,3 +1,4 @@ +blank_issues_enabled: false contact_links: - name: Roots Discourse url: https://discourse.roots.io diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 1fbef13..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project ---- - - - -* [ ] I've read the [guidelines for Contributing to Roots Projects](https://github.com/roots/.github/blob/master/CONTRIBUTING.md) -* [ ] This request isn't a duplicate of an existing request -* [ ] This is not a personal support request that should be posted on the [Roots Discourse](https://discourse.roots.io/) community - -## Summary - -One paragraph explanation of the feature. - -## Motivation - -Why are we doing this? What use cases does it support? What is the expected outcome? - -## 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..8bed343 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,56 @@ +name: Feature Request +description: Suggest an idea for this project +title: "Feature Request: " +labels: [feature, enhancement] + +body: + - type: markdown + attributes: + value: | + This form is for suggesting an idea for this project. + If you have a question or you're looking for support, please visit [Roots Discourse](https://discourse.roots.io/). + + - type: checkboxes + id: terms + attributes: + options: + - label: I have read the [guidelines for Contributing to Roots Projects](https://github.com/roots/.github/blob/master/CONTRIBUTING.md) + required: true + - label: This request is not a duplicate of an existing issue + required: true + - label: This is not a personal support request that should be posted on the [Roots Discourse](https://discourse.roots.io/) community + required: true + + - type: textarea + id: summary + attributes: + label: Summary + description: One paragraph explanation of the feature. + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: Motivation + value: | + #### Why are we doing this? + + #### What use cases does it support? + + #### What is the expected outcome? + + #### Potential conflicts / foreseeable issues + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. + + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request form!