From 15d1936f287fca1b861c9259be7b94499df786e8 Mon Sep 17 00:00:00 2001 From: woodiertexas Date: Wed, 4 Sep 2024 08:07:18 -0700 Subject: [PATCH] add issue templates (#250) * add issue templates * make these templates actually work * config.yaml -> config.yml * issue template files are now `.yml` instead of `.yaml` for consistency's sake * add blurb about making sure to use the latest browser version * Apply suggestions from code review Co-authored-by: Southpaw <44805409+Southpaw1496@users.noreply.github.com> * "Feature Request" -> "Enhancement" * improve bug_report.yml * "Feature Request" -> "Enhancement" again... * fix field ids * screw it, lets update the editorconfig too * add template for reporting content issues * Apply suggestions from code review Co-authored-by: Southpaw <44805409+Southpaw1496@users.noreply.github.com> * rename feature_request.yml to enhancement.yml * remove OS info field * remove discord links * remove browser input field * Apply suggestions from code review Co-authored-by: Southpaw <44805409+Southpaw1496@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/enhancement.yml Co-authored-by: Southpaw <44805409+Southpaw1496@users.noreply.github.com> [skip ci] --------- Co-authored-by: Southpaw <44805409+Southpaw1496@users.noreply.github.com> --- .editorconfig | 3 +- .github/ISSUE_TEMPLATE/bug_report.yml | 48 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .../ISSUE_TEMPLATE/content_issue_report.yml | 16 +++++++ .github/ISSUE_TEMPLATE/enhancement.yml | 17 +++++++ 5 files changed, 88 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/content_issue_report.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml diff --git a/.editorconfig b/.editorconfig index 174102238..f37abb0d4 100644 --- a/.editorconfig +++ b/.editorconfig @@ -7,5 +7,6 @@ end_of_line=lf insert_final_newline=true trim_trailing_whitespace=true -[*.yml] +[*.{yml,yaml}] indent_style = space +indent_size = 2 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..657d128e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,48 @@ +name: Bug Report +description: Report a bug or unexpected behaviour with the website. +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report this bug! + + - type: textarea + id: how-to-reproduce + attributes: + label: Reproduction steps + description: "Please describe how to reproduce the bug." + validations: + required: true + + - type: textarea + id: expected-results + attributes: + label: Expected results + description: "What should happen when you follow the reproduction steps?" + validations: + required: true + + - type: textarea + id: actual-results + attributes: + label: Actual results + description: "What actually happened?" + validations: + required: true + + - type: input + id: device-and-os + attributes: + label: Device and OS + description: The type of device and operating system you were using when the error occurred. + validations: + required: true + + - type: input + id: browser + attributes: + label: Browser information. + description: "The browser you were using and its version, if you know it." + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..15e7381c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Join the Discord for support. + url: https://discord.quiltmc.org + about: Discuss the Quilt website on our Discord server. diff --git a/.github/ISSUE_TEMPLATE/content_issue_report.yml b/.github/ISSUE_TEMPLATE/content_issue_report.yml new file mode 100644 index 000000000..23979b373 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/content_issue_report.yml @@ -0,0 +1,16 @@ +name: Content Issue Report +description: Report a content issue on the website. +labels: [content issue] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report this content issue! + + - type: textarea + id: description + attributes: + label: Describe the issue + description: "Please describe the content issue you found." + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..18233e20a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,17 @@ +name: Enhancement +description: Suggest a new feature or improvement for the website. +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest this enhancement! + + - type: textarea + id: description + attributes: + label: Describe what feature(s) you want. + description: "Describe the enhancement in as much detail as possible. What does it do? What problem does it solve? How might it work?" + validations: + required: true +