Skip to content

Commit

Permalink
Improve GitHub issue templates (now with gherkin!) (#1689)
Browse files Browse the repository at this point in the history
## Description

This refines our issue templates, adding more labels and gherkin where
appropriate to better capture feature requests.

## Related Issue

Fixes #N/A

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [X] Other (security config, docs update, etc)

## Checklist before merging

- [N/A] Test, docs, adr added or updated as needed
- [X] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed
  • Loading branch information
Racer159 committed May 11, 2023
1 parent 1dd1d3c commit 8e0a81a
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Create a report to help us improve
title: ''
labels: possible-bug
assignees: ''

---

### Environment
Expand All @@ -25,3 +24,4 @@ Other:
### Severity/Priority

### Additional Context
Add any other context or screenshots about the technical debt here.
10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/tech_debt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
23 changes: 15 additions & 8 deletions .github/ISSUE_TEMPLATE/ux_test.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8e0a81a

Please sign in to comment.