From 287278219a420995c671b11dde25f2ae85df7fbc Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Mon, 20 Jan 2025 10:53:46 -0800 Subject: [PATCH] Improve issue templates Deleted feature request as that has to do with the website which is more or less the same as an enhancement (now a website enhancement). Improved/fixed labels. --- .github/ISSUE_TEMPLATE/author_details.yml | 2 +- .github/ISSUE_TEMPLATE/bug_report.yml | 10 ++-- .github/ISSUE_TEMPLATE/documentation.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 47 ------------------- .github/ISSUE_TEMPLATE/rules_guidelines.yml | 4 +- ...nhancement.yml => website_enhancement.yml} | 8 ++-- .github/ISSUE_TEMPLATE/website_issue.yml | 2 +- 7 files changed, 14 insertions(+), 61 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml rename .github/ISSUE_TEMPLATE/{enhancement.yml => website_enhancement.yml} (89%) diff --git a/.github/ISSUE_TEMPLATE/author_details.yml b/.github/ISSUE_TEMPLATE/author_details.yml index af65a50f0..28d47fc3f 100644 --- a/.github/ISSUE_TEMPLATE/author_details.yml +++ b/.github/ISSUE_TEMPLATE/author_details.yml @@ -1,6 +1,6 @@ name: Author details description: Report a problem with information about a winning author -title: "[Author] " +title: "Author: <issue synopsis>" labels: ["author"] body: - type: checkboxes diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 071676825..c25d9a1e8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,7 +1,7 @@ name: Bug report description: Report a bug with a tool -title: "[Bug] <title>" -labels: ["bug"] +title: "Bug: <bug synopsis>" +labels: ["bug", "tool"] body: - type: checkboxes attributes: @@ -31,9 +31,9 @@ body: label: Environment description: | Example: - - **OS**: macOS Sonoma 14.5 - - **Device**: MacBook Pro M1 - - **Shell**: GNU bash, version 5.2.26(1)-release (aarch64-apple-darwin23.2.0) + - **OS**: macOS Sequoia 15.2 + - **Device**: MacBook Pro M1 Max + - **Shell**: GNU bash, version 5.2.37(1)-release (aarch64-apple-darwin24.0.0) **PLEASE** provide **AT** **LEAST** the above items. If you have the **SAME** problem with more than one device please list the above for **ALL** **RELEVANT** **devices** with **any** **relevant** **context**. value: | diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index c080ab450..d291d2a73 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -1,6 +1,6 @@ name: Documentation issue description: Report a problem with documentation -title: "[Documentation] <title>" +title: "Documentation: <issue synopsis>" labels: ["documentation"] body: - type: checkboxes diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index 695e1847e..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,47 +0,0 @@ -name: Feature request -description: Suggest a feature -title: "[Feature] <title>" -labels: ["feature"] -body: -- type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the feature you're suggesting. - options: - - label: I have searched for existing issues and did not find anything like this - required: true - -- type: textarea - attributes: - label: Describe the feature - description: | - Please describe the feature you would like to have and why, as best you can (the more details you provide the better). - validations: - required: true - -- type: textarea - attributes: - label: Relevant images, screenshots or other files - description: | - If you have images or other files that will help explain what you're getting at, this can also be **EXTREMELY** helpful. - - Tip: you can attach files by clicking the text area to highlight it and then click the link that says paste, drop or click to add files. - validations: - required: false - -- type: textarea - attributes: - label: Relevant links - description: Please provide us with a list of relevant links, if applicable. - validations: - required: false - -- type: textarea - attributes: - label: Anything else? - description: | - Do you have any additional context or information? Please let us know! - - validations: - required: false - diff --git a/.github/ISSUE_TEMPLATE/rules_guidelines.yml b/.github/ISSUE_TEMPLATE/rules_guidelines.yml index 4c87760d9..fa5ab7381 100644 --- a/.github/ISSUE_TEMPLATE/rules_guidelines.yml +++ b/.github/ISSUE_TEMPLATE/rules_guidelines.yml @@ -1,7 +1,7 @@ name: Rules and/or Guidelines issue description: Report a problem with the Rules and/or Guidelines -title: "[Rules and Guidelines] <title>" -labels: ["Rules and Guidelines"] +title: "Rules and Guidelines: <issue synopsis>" +labels: ["rules", "guidelines"] body: - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/website_enhancement.yml similarity index 89% rename from .github/ISSUE_TEMPLATE/enhancement.yml rename to .github/ISSUE_TEMPLATE/website_enhancement.yml index 5db0398fa..130e75b37 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/website_enhancement.yml @@ -1,7 +1,7 @@ -name: Enhancement -description: Suggest an enhancement -title: "Enhancement: <enhancement title>" -labels: ["enhancement"] +name: Website enhancement +description: Suggest a website enhancement +title: "Website enhancement: <enhancement synopsis>" +labels: ["enhancement", "website"] body: - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/website_issue.yml b/.github/ISSUE_TEMPLATE/website_issue.yml index fb8e9cfae..edd8bb941 100644 --- a/.github/ISSUE_TEMPLATE/website_issue.yml +++ b/.github/ISSUE_TEMPLATE/website_issue.yml @@ -1,6 +1,6 @@ name: Website issue description: Report a problem with the website -title: "[Website] <title>" +title: "Website: <issue synopsis>" labels: ["website"] body: - type: checkboxes