From b446c9731121cacea4f9c2f59b9de694a82c79c9 Mon Sep 17 00:00:00 2001 From: Octol1ttle Date: Wed, 22 Nov 2023 13:26:10 +0500 Subject: [PATCH] Make issue templates less annoying (#194) Closes #184 This PR makes issue templates less annoying by removing some unnecessary text boxes and allowing issues to be created without the use of a template. In the Bug Report template, `Expected Behavior` and `Actual Behavior` were combined into one, and the `Known Workarounds` section was removed In the Feature Request template, `Considered Alternatives` was also removed. --- .github/ISSUE_TEMPLATE/bug-report.yml | 55 +++++----------------- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 9 ---- 3 files changed, 12 insertions(+), 54 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 691e635..9c0524f 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -14,6 +14,15 @@ body: placeholder: Description validations: required: true + - type: textarea + id: expected-vs-actual-behavior + attributes: + label: Expected vs. Actual Behavior + description: | + Provide a description of the expected behavior compared to the actual behavior. + placeholder: Expected vs. Actual Behavior + validations: + required: true - type: textarea id: repro-steps attributes: @@ -23,54 +32,12 @@ body: placeholder: Minimal Reproduction validations: required: true - - type: textarea - id: expected-behavior - attributes: - label: Expected behavior - description: | - Provide a description of the expected behavior. - placeholder: Expected behavior - validations: - required: true - - type: textarea - id: actual-behavior - attributes: - label: Actual behavior - description: | - Provide a description of the actual behavior observed. If applicable please include any error messages, exception stacktraces or memory dumps. - placeholder: Actual behavior - validations: - required: true - - type: textarea - id: known-workarounds - attributes: - label: Known Workarounds - description: | - Please provide a description of any known workarounds. - placeholder: Known Workarounds - validations: - required: false - - type: textarea - id: configuration - attributes: - label: Configuration - description: | - Please provide more information on your configuration: - * Which version of .NET is the bot running on? - * What OS and version, and what distro if applicable? - * What is the architecture (x64, x86, ARM, ARM64)? - * Do you know whether it is specific to that configuration? - * If possible, please provide the Configuration.json for the affected guild - * If applicable, provide the member data JSON for the affected members - placeholder: Configuration - validations: - required: false - type: textarea id: other-info attributes: - label: Other information + label: Other Information description: | If you have an idea where the problem might lie, let us know that here. Please include any pointers to code, relevant changes, or related issues you know of. - placeholder: Other information + placeholder: Other Information validations: required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3ba13e0..0086358 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1 @@ -blank_issues_enabled: false +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index e840cf6..2fd43c5 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -18,15 +18,6 @@ body: placeholder: Proposed Solution validations: required: true - - type: textarea - id: alternatives - attributes: - label: Considered Alternatives - description: | - Please provide a description of any alternative solutions or features you've considered. - placeholder: Considered Alternatives - validations: - required: false - type: textarea id: other-info attributes: