From 504e0f8d297fb89b6eeb8b391e6e6cced1e2207c Mon Sep 17 00:00:00 2001 From: Katie Stahl Date: Wed, 24 Dec 2025 11:31:56 -0500 Subject: [PATCH 1/6] chore: revise issue templates --- .github/ISSUE_TEMPLATE/bug-report.yaml | 51 ++++----------------- .github/ISSUE_TEMPLATE/feature-request.yaml | 38 ++++----------- 2 files changed, 18 insertions(+), 71 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index c5b24f7..b7c0990 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -11,7 +11,7 @@ body: - type: textarea attributes: label: Steps to reproduce - description: Provide detailed steps to replicate the bug. + description: Provide detailed steps to replicate the bug. Make sure to describe the current behavior. If applicable, include full errors, stack traces, and/or relevant logs. placeholder: | 1. In this environment... 2. With this config... @@ -25,33 +25,24 @@ body: description: What did you expect to happen? validations: required: true - - type: textarea - attributes: - label: Current behavior - description: | - What actually happened? - - Include full errors, stack traces, and/or relevant logs. - validations: - required: true - type: textarea attributes: label: Acceptance Criteria description: | Provide the criteria that must be met in order for this issue to be considered fixed. - Be specific, and consider potential edge cases. + Be specific, and consider potential edge cases. The criteria should be observable and testable. + placeholder: | + Given a user or system is in ... (a page, workflow, or state) + And ... (optional other criteria that needs to be met) + When the user ... (action) + Then ... (expected outcome) + And ... (additional observable outcome) validations: required: true - type: textarea attributes: - label: Possible reason(s) - description: Provide any insights into what might be causing the issue. - validations: - required: false - - type: textarea - attributes: - label: Suggested fix - description: Provide any suggestions on how to resolve the bug. + label: Possible reason(s)/Suggested Fix + description: Provide any insights into what might be causing the issue or how to resolve it. validations: required: false - type: textarea @@ -63,31 +54,9 @@ body: commit: abc123d validations: required: true - - type: textarea - attributes: - label: Screenshots - description: If applicable, add screenshots with descriptions to help explain your problem. - validations: - required: false - type: textarea attributes: label: Environment details description: Provide environment details (OS name and version, etc). validations: required: true - - type: textarea - attributes: - label: Additional details - description: Provide any other additional details about the problem. - validations: - required: false - - type: dropdown - attributes: - label: Contribution - description: Can you contribute to the development of this feature? - options: - - "Yes, I can create a PR for this fix." - - "Yes, but I can only provide ideas and feedback." - - "No, I cannot contribute." - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index b7ec03b..d7ab1a4 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -20,25 +20,19 @@ body: label: Acceptance Criteria description: | Provide the criteria that must be met in order for this issue to be considered complete. - Be specific, and consider potential edge cases. + Be specific, and consider potential edge cases. The criteria should be observable and testable. + placeholder: | + Given a user or system is in ... (a page, workflow, or state) + And ... (optional other criteria that needs to be met) + When the user ... (action) + Then ... (expected outcome) + And ... (additional observable outcome) validations: required: true - type: textarea attributes: label: Proposed solution - description: Provide proposed solution. - validations: - required: false - - type: textarea - attributes: - label: Alternatives considered - description: Describe any alternative solutions you've considered. - validations: - required: false - - type: textarea - attributes: - label: Implementation details - description: Provide any technical details on how the feature might be implemented. + description: Provide proposed solution and any technical details on how the feature might be implemented. validations: required: false - type: textarea @@ -50,19 +44,3 @@ body: What challenges might arise? validations: required: false - - type: textarea - attributes: - label: Additional context - description: Provide any other context or screenshots about the feature. - validations: - required: false - - type: dropdown - attributes: - label: Contribution - description: Can you contribute to the development of this feature? - options: - - "Yes, I can create a PR for this feature." - - "Yes, but I can only provide ideas and feedback." - - "No, I cannot contribute." - validations: - required: false From 0e07da38e39dec57cbd6aba96debbf98cd54d0a8 Mon Sep 17 00:00:00 2001 From: Katie Stahl Date: Wed, 24 Dec 2025 11:34:08 -0500 Subject: [PATCH 2/6] remove expected behavior --- .github/ISSUE_TEMPLATE/bug-report.yaml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index b7c0990..94d81e0 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -19,12 +19,6 @@ body: 4. See error... validations: required: true - - type: textarea - attributes: - label: Expected behavior - description: What did you expect to happen? - validations: - required: true - type: textarea attributes: label: Acceptance Criteria From 4d866b8ffd089ca67957b3b2e1042084d9508283 Mon Sep 17 00:00:00 2001 From: Katie Stahl Date: Mon, 29 Dec 2025 11:53:22 -0500 Subject: [PATCH 3/6] adjust wording and combine sections --- .github/ISSUE_TEMPLATE/bug-report.yaml | 29 +++++++++++---------- .github/ISSUE_TEMPLATE/feature-request.yaml | 6 +++-- 2 files changed, 19 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 94d81e0..40813df 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -5,13 +5,15 @@ body: - type: textarea attributes: label: Describe the bug - description: Provide a clear and concise description of what the bug is. + description: Provide a clear and concise description of what the bug is. Include screenshots if applicable. validations: required: true - type: textarea attributes: label: Steps to reproduce - description: Provide detailed steps to replicate the bug. Make sure to describe the current behavior. If applicable, include full errors, stack traces, and/or relevant logs. + description: | + Provide detailed steps to replicate the bug. Make sure to describe the current behavior. + If applicable, include full errors, stack traces, and/or relevant logs. placeholder: | 1. In this environment... 2. With this config... @@ -41,16 +43,15 @@ body: required: false - type: textarea attributes: - label: Branch, commit, and/or version - description: Provide the branch, commit, and/or version you're using. + label: Environment & Version + description: | + Provide the branch, commit, and/or version you're using, along with environment details + (e.g., OS name and version, browser, runtime, deployment environment). placeholder: | - branch: issue-1 - commit: abc123d - validations: - required: true - - type: textarea - attributes: - label: Environment details - description: Provide environment details (OS name and version, etc). - validations: - required: true + branch: + commit: + version: + environment: + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index d7ab1a4..6cf3249 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -5,7 +5,9 @@ body: - type: textarea attributes: label: Feature description - description: Provide a clear and concise description of what you want to happen. + description: | + Provide a clear and concise description of what you want to happen. + Include screenshots, wireframes, mockups, diagrams, or other supporting artifacts if available. validations: required: true - type: textarea @@ -32,7 +34,7 @@ body: - type: textarea attributes: label: Proposed solution - description: Provide proposed solution and any technical details on how the feature might be implemented. + description: Describe a possible solution or any technical considerations, if known. validations: required: false - type: textarea From 95a996b8fdb65459792d52fafc9e0d80ca5e5e7a Mon Sep 17 00:00:00 2001 From: Katie Perry Date: Wed, 31 Dec 2025 11:26:30 -0500 Subject: [PATCH 4/6] Update .github/ISSUE_TEMPLATE/bug-report.yaml Co-authored-by: Kori Kuzma --- .github/ISSUE_TEMPLATE/bug-report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 40813df..15a6b36 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -38,7 +38,7 @@ body: - type: textarea attributes: label: Possible reason(s)/Suggested Fix - description: Provide any insights into what might be causing the issue or how to resolve it. + description: Provide any insights into what might be causing the issue and/or how to resolve it. validations: required: false - type: textarea From a3462289e70ccfdc9555429dbd95cb7332286ca9 Mon Sep 17 00:00:00 2001 From: Katie Stahl Date: Wed, 31 Dec 2025 12:48:01 -0500 Subject: [PATCH 5/6] be more clear in placeholder for environemnt details --- .github/ISSUE_TEMPLATE/bug-report.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 15a6b36..d1fabcf 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -51,7 +51,9 @@ body: branch: commit: version: - environment: + browser (if applicable - Chrome, Firefox, Safari, etc.): + deployment environment (dev, prod, staging, local): + operating system (Mac, Windows, Linux, other): validations: required: false From 36c21a58e9303d823697c6b153bd9f8643c98550 Mon Sep 17 00:00:00 2001 From: Katie Stahl Date: Wed, 31 Dec 2025 12:48:36 -0500 Subject: [PATCH 6/6] make environment details required --- .github/ISSUE_TEMPLATE/bug-report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index d1fabcf..985a1cc 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -55,5 +55,5 @@ body: deployment environment (dev, prod, staging, local): operating system (Mac, Windows, Linux, other): validations: - required: false + required: true