From aa4fc726ccd46883ef853d806393f2715c026bef Mon Sep 17 00:00:00 2001 From: Wayne Starr Date: Wed, 10 May 2023 12:24:53 -0500 Subject: [PATCH 1/2] Improve templates + add gherkin --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 10 ++++++---- .github/ISSUE_TEMPLATE/tech_debt.md | 3 +-- .github/ISSUE_TEMPLATE/ux_test.md | 23 +++++++++++++++-------- 4 files changed, 23 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e2b0b69764..fb4fe1681b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,7 +4,6 @@ about: Create a report to help us improve title: '' labels: possible-bug assignees: '' - --- ### Environment @@ -25,3 +24,4 @@ Other: ### Severity/Priority ### Additional Context +Add any other context or screenshots about the technical debt here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b2de4ff56c..056cca7b64 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,19 +2,21 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: '' +labels: 'enhancement' assignees: '' - --- ### Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] ### Describe the solution you'd like -A clear and concise description of what you want to happen. + +**Given** a state +**When** an action is taken +**Then** something happens ### Describe alternatives you've considered -A clear and concise description of any alternative solutions or features you've considered. +(optional) A clear and concise description of any alternative solutions or features you've considered. ### Additional context Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/tech_debt.md b/.github/ISSUE_TEMPLATE/tech_debt.md index 682617686a..b39ccf5e8e 100644 --- a/.github/ISSUE_TEMPLATE/tech_debt.md +++ b/.github/ISSUE_TEMPLATE/tech_debt.md @@ -4,14 +4,13 @@ about: Record something that should be investigated or refactored in the future. title: '' labels: 'tech-debt' assignees: '' - --- ### Describe what should be investigated or refactored A clear and concise description of what should be changed/researched. Ex. This piece of the code is not DRY enough [...] ### Links to any relevant code -https://github.com/defenseunicorns/zarf/blob/main/README.md?plain=1#L1 +(optional) i.e. - https://github.com/defenseunicorns/zarf/blob/main/README.md?plain=1#L1 ### Additional context Add any other context or screenshots about the technical debt here. diff --git a/.github/ISSUE_TEMPLATE/ux_test.md b/.github/ISSUE_TEMPLATE/ux_test.md index 17d9376b02..6aba7ccb3f 100644 --- a/.github/ISSUE_TEMPLATE/ux_test.md +++ b/.github/ISSUE_TEMPLATE/ux_test.md @@ -1,16 +1,23 @@ -## Driving Questions ## -*What are we hoping to validate?* +--- +name: UX Test +about: Record something that should be investigated to test User Experience +title: '' +labels: 'ux' +assignees: '' +--- +## Driving Questions +What are we hoping to validate? -## Testing Plan ## -User persona: +## Testing Plan +User Persona: Sample Group: - [ ] Use Checklist for Tasks -## Additional context ## -*Screenshot or link to what needs to be tested* +## Additional context +Add any other context or screenshots about the UX test here. -Related to issue +Related to issue: # -## Link to Test & Results ## +## Link to Test & Results From 7393083ffb8e7cd75900dd13f7d804ae3a31c924 Mon Sep 17 00:00:00 2001 From: Wayne Starr Date: Wed, 10 May 2023 12:30:08 -0500 Subject: [PATCH 2/2] Make the gherkin go on different lines --- .github/ISSUE_TEMPLATE/feature_request.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 056cca7b64..7928b9558e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -11,9 +11,9 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate ### Describe the solution you'd like -**Given** a state -**When** an action is taken -**Then** something happens +- **Given** a state +- **When** an action is taken +- **Then** something happens ### Describe alternatives you've considered (optional) A clear and concise description of any alternative solutions or features you've considered.