From e54fcd776904df30913a9257a52361f19d34cdf4 Mon Sep 17 00:00:00 2001 From: Turiiya <34311583+ttytm@users.noreply.github.com> Date: Sat, 21 Oct 2023 08:36:39 +0200 Subject: [PATCH] github: simplify templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 20 ++++---------------- .github/ISSUE_TEMPLATE/feature-request.yml | 20 +++++--------------- 2 files changed, 9 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index ea641a8..8115b70 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -5,8 +5,10 @@ body: - type: textarea id: description attributes: - label: Describe the bug - description: What is the problem? A clear and concise description of the bug. + label: What is the problem? + description: | + Provide a clear and concise description of the problem. + Add a minimal runnable code snippet that isolates the bug. validations: required: true @@ -30,20 +32,6 @@ body: validations: required: true - - type: textarea - id: reproduction - attributes: - label: Reproduction Steps - description: | - Provide a self-contained, concise snippet of code that can be used to reproduce the issue. - For more complex issues provide a repo with the smallest sample that reproduces the bug. - - Avoid including business logic or unrelated code, it makes diagnosis more difficult. - The code sample should be an SSCCE. See http://sscce.org/ for details. - In short, please provide a code sample that we can copy/paste, run and reproduce. - validations: - required: true - - type: textarea id: solution attributes: diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 629e822..60c3c89 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -5,17 +5,8 @@ body: - type: textarea id: description attributes: - label: Describe the feature - description: A clear and concise description of the feature you are proposing. - validations: - required: true - - - type: textarea - id: use-case - attributes: - label: Use Case - description: | - Why do you need this feature? For example: "I'm always frustrated when..." + label: Description + description: Describe the desired feature and it's use-case. validations: required: true @@ -28,9 +19,9 @@ body: required: false - type: textarea - id: other + id: context attributes: - label: Other Information + label: Additional Information/Context description: Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc. validations: required: false @@ -42,8 +33,7 @@ body: options: - label: I may be able to implement this feature request required: false - - - label: This feature might incur a breaking change + - label: This feature might introduce a breaking change required: false - type: textarea