diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index c5b24f7..985a1cc 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... @@ -19,75 +21,39 @@ 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: 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. - 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. + 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 b7ec03b..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 @@ -20,25 +22,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: Describe a possible solution or any technical considerations, if known. validations: required: false - type: textarea @@ -50,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