From e5c06001ff551d2e5b8ab826f849ff6029ed03e7 Mon Sep 17 00:00:00 2001 From: Katie Stahl Date: Fri, 2 Jan 2026 11:52:11 -0500 Subject: [PATCH 1/2] chore: update issue templates --- .github/ISSUE_TEMPLATE/bug-report.yaml | 81 +++++++-------------- .github/ISSUE_TEMPLATE/feature-request.yaml | 44 ++++------- 2 files changed, 43 insertions(+), 82 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 5b3f7c8d..85d0b3df 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. + 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... @@ -21,65 +23,36 @@ body: required: true - type: textarea attributes: - label: Expected behavior - description: What did you expect to happen? - validations: - required: true - - type: textarea - attributes: - label: Current behavior + label: Acceptance Criteria description: | - What actually happened? - - Include full errors, stack traces, and/or relevant logs. - 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. - validations: - required: false - - type: textarea - attributes: - label: Branch, commit, and/or version - description: Provide the branch, commit, and/or version you're using. + Provide the criteria that must be met in order for this issue to be considered fixed. + Be specific, and consider potential edge cases. The criteria should be observable and testable. placeholder: | - branch: issue-1 - commit: abc123d + 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: Screenshots - description: If applicable, add screenshots with descriptions to help explain your problem. + label: Possible reason(s)/Suggested Fix + description: Provide any insights into what might be causing the issue and/or how to resolve it. 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 + 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: + commit: + version: + browser (if applicable - Chrome, Firefox, Safari, etc.): + deployment environment (dev, prod, staging, local): + operating system (Mac, Windows, Linux, other): + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index 2e1ae644..6fd687e4 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 @@ -17,20 +19,22 @@ body: 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. + 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. 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: false + required: true - type: textarea attributes: - label: Implementation details - description: Provide any technical details on how the feature might be implemented. + label: Proposed solution + description: Describe a possible solution or any technical considerations, if known. validations: required: false - type: textarea @@ -42,19 +46,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 87652677d946fba781ca4fed4ed3800ee2c6176b Mon Sep 17 00:00:00 2001 From: Katie Stahl Date: Fri, 2 Jan 2026 12:11:07 -0500 Subject: [PATCH 2/2] chore: remove issue template overrides to use organization global templates instead --- .github/ISSUE_TEMPLATE/bug-report.yaml | 58 --------------------- .github/ISSUE_TEMPLATE/feature-request.yaml | 48 ----------------- 2 files changed, 106 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml deleted file mode 100644 index 85d0b3df..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ /dev/null @@ -1,58 +0,0 @@ -name: Bug Report -description: Report a bug. -labels: ["bug"] -body: - - type: textarea - attributes: - label: Describe the bug - 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. - placeholder: | - 1. In this environment... - 2. With this config... - 3. Run '...' - 4. See error... - 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. 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)/Suggested Fix - description: Provide any insights into what might be causing the issue and/or how to resolve it. - validations: - required: false - - type: textarea - attributes: - 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: - commit: - version: - browser (if applicable - Chrome, Firefox, Safari, etc.): - deployment environment (dev, prod, staging, local): - operating system (Mac, Windows, Linux, other): - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml deleted file mode 100644 index 6fd687e4..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ /dev/null @@ -1,48 +0,0 @@ -name: Feature Request -description: Suggest an idea for this project. -labels: ["enhancement"] -body: - - type: textarea - attributes: - label: Feature description - 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 - attributes: - label: Use case - description: | - Why do you need this feature? For example: "I'm always frustrated when..." - 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 complete. - 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: Describe a possible solution or any technical considerations, if known. - validations: - required: false - - type: textarea - attributes: - label: Potential Impact - description: | - Discuss any potential impacts of this feature on existing functionality or performance, if known. - Will this feature cause breaking changes? - What challenges might arise? - validations: - required: false