From ff325301f1f4826d68fa179b8914638b5cfed819 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Fri, 12 Feb 2021 10:40:21 +0000 Subject: [PATCH 1/2] .github/ISSUE_TEMPLATE/{bug,feature}.yml: update syntax. --- .github/ISSUE_TEMPLATE/bug.yml | 10 ++++++++-- .github/ISSUE_TEMPLATE/feature.yml | 8 ++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 8d4100bfe2..a7505b3b47 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -3,36 +3,42 @@ about: "If you're sure it's reproducible and not just your machine: submit an is labels: bug issue_body: false inputs: - - type: description + - type: markdown attributes: value: Please note we will close your issue without comment if you do not fill out the issue checklist below and provide ALL the requested information. If you repeatedly fail to use the issue template, we will block you from ever submitting issues to Homebrew again. - type: textarea attributes: label: "`brew config` output" + validations: required: true - type: textarea attributes: label: "`brew doctor` output" + validations: required: true - type: checkboxes attributes: description: Please verify that you've followed these steps - choices: + options: - label: The `brew doctor` above contains no "Warning" lines. required: true - type: textarea attributes: label: What were you trying to do (and why)? + validations: required: true - type: textarea attributes: label: What happened (include all command output)? + validations: required: true - type: textarea attributes: label: What did you expect to happen? + validations: required: true - type: textarea attributes: label: Step-by-step reproduction instructions (by running `brew` commands) + validations: required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 361f7b0ac3..d0c60bc732 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -3,25 +3,29 @@ about: Request our thoughts on your suggestion for a new feature for Homebrew. labels: features issue_body: false inputs: - - type: description + - type: markdown attributes: value: Please note we will close your issue without comment if you do not fill out the issue checklist below and provide ALL the requested information. If you repeatedly fail to use the issue template, we will block you from ever submitting issues to Homebrew again. - type: textarea attributes: label: Provide a detailed description of the proposed feature + validations: required: true - type: textarea attributes: label: What is the motivation for the feature? + validations: required: true - type: textarea attributes: label: How will the feature be relevant to at least 90% of Homebrew users? + validations: required: true - type: textarea attributes: label: What alternatives to the feature have been considered? + validations: required: true - - type: description + - type: markdown attributes: value: We will close this issue or ask you to create a pull-request if it's something the maintainers are not actively planning to work on. From 3cb3b34c09578387fd15200d6b919a9ccd03f02b Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Fri, 12 Feb 2021 17:35:00 +0000 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Megan O'Neill --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- .github/ISSUE_TEMPLATE/feature.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index a7505b3b47..721146d42d 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -2,7 +2,7 @@ name: New issue for Reproducible Bug about: "If you're sure it's reproducible and not just your machine: submit an issue so we can investigate." labels: bug issue_body: false -inputs: +body: - type: markdown attributes: value: Please note we will close your issue without comment if you do not fill out the issue checklist below and provide ALL the requested information. If you repeatedly fail to use the issue template, we will block you from ever submitting issues to Homebrew again. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index d0c60bc732..e92e7dfe95 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -2,7 +2,7 @@ name: New issue for Feature Suggestion about: Request our thoughts on your suggestion for a new feature for Homebrew. labels: features issue_body: false -inputs: +body: - type: markdown attributes: value: Please note we will close your issue without comment if you do not fill out the issue checklist below and provide ALL the requested information. If you repeatedly fail to use the issue template, we will block you from ever submitting issues to Homebrew again.