From 155de205bb996c0d5499c69ccb19946a892172b4 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Mon, 1 Jul 2024 07:45:21 -0700 Subject: [PATCH] Add issue template, fix others The documentation template is for a missing documentation file or problem with documentation. This MIGHT be classified under a website issue but it is kind of a topic on its own and as an issue for this was recently opened (with the documentation label) this seems like a worthy thing to have. The bug issue template now properly adds the 'bug' label. The other issue templates have lower case labels. --- .github/ISSUE_TEMPLATE/author_details.yml | 2 +- .github/ISSUE_TEMPLATE/bug_report.yml | 1 + .github/ISSUE_TEMPLATE/documentation.yml | 56 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/other_issue.yml | 1 + .github/ISSUE_TEMPLATE/website_issue.yml | 2 +- 6 files changed, 61 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml diff --git a/.github/ISSUE_TEMPLATE/author_details.yml b/.github/ISSUE_TEMPLATE/author_details.yml index 7b2566459..af65a50f0 100644 --- a/.github/ISSUE_TEMPLATE/author_details.yml +++ b/.github/ISSUE_TEMPLATE/author_details.yml @@ -1,7 +1,7 @@ name: Author details description: Report a problem with information about a winning author title: "[Author] " -labels: ["Author"] +labels: ["author"] body: - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c9c6ae3b5..e43df6640 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,7 @@ name: Bug report description: Report a bug with a tool title: "[Bug] <title>" +labels: ["bug"] body: - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000..c080ab450 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,56 @@ +name: Documentation issue +description: Report a problem with documentation +title: "[Documentation] <title>" +labels: ["documentation"] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the problem you're reporting. + options: + - label: I have searched for existing issues and did not find anything like it + required: true +- type: textarea + attributes: + label: Describe the problem with or missing documentation + description: Please let us know what documentation problem there is. + validations: + required: true + +- type: textarea + attributes: + label: Relevant files + description: | + Do you have any **relevant** files? This **can** be **EXTREMELY** helpful, if you do. + + 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: What you expect + description: | + Please describe what you think is missing or is incorrect and why, as best you can (the more details you provide the better). 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: true + +- type: textarea + attributes: + label: Relevant links or files + description: Please provide us with a list of relevant links or files, if applicable. + validations: + required: false + +- type: textarea + attributes: + label: Anything else? + description: | + Do you have any additional context or information? + + 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 + diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index b56dcd0ff..695e1847e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,7 +1,7 @@ name: Feature request description: Suggest a feature title: "[Feature] <title>" -labels: ["Feature"] +labels: ["feature"] body: - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/other_issue.yml b/.github/ISSUE_TEMPLATE/other_issue.yml index 4fafdc468..e488cb926 100644 --- a/.github/ISSUE_TEMPLATE/other_issue.yml +++ b/.github/ISSUE_TEMPLATE/other_issue.yml @@ -1,6 +1,7 @@ name: Other issue description: Some problem not listed title: "[Other] <title>" +labels: ["other"] body: - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/website_issue.yml b/.github/ISSUE_TEMPLATE/website_issue.yml index 4c0585e2c..fb8e9cfae 100644 --- a/.github/ISSUE_TEMPLATE/website_issue.yml +++ b/.github/ISSUE_TEMPLATE/website_issue.yml @@ -1,7 +1,7 @@ name: Website issue description: Report a problem with the website title: "[Website] <title>" -labels: ["Website"] +labels: ["website"] body: - type: checkboxes attributes: