Skip to content

Commit

Permalink
#91 Create Github Issue Templates (#101)
Browse files Browse the repository at this point in the history
* Create Github Issue Templates

Creating issue templates to engender consistency when creating Github Issues.

* Update bug_report.md

Changed ordering of description sections.
  • Loading branch information
nartieri authored May 23, 2024
1 parent 5622535 commit d9309af
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: 'BUG:'
labels: bug
assignees: ''

---

## Description
A clear and concise description of what the bug is, including the current behavior.

## Steps to Reproduce
Clear, specific, and detailed steps taken to enable reproduction of the bug for investigation.
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected Behavior
A clear and concise description of the outcome you expected from the actions taken.

## Actual Behavior
A clear and concise description of the outcome you experienced from the actions taken.

## Additional Context
- Log output
- Screenshots (if applicable)
- Solution Baseline Version
- Environment details (local, cloud, Azure, AWS, etc.)
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest a feature for this project
title: 'Feature:'
labels: enhancement
assignees: ''

---

## Description
A clear and concise description of the new feature. It can include what the problem is and what you want to happen, and is preferably focused on the business context or how this impacts downstream users.

## DOD
Acceptance criteria required to realize the requested feature
- [ ] Using checkboxes helps to communicate progress

## Test Strategy/Script
How will this feature be verified?

## References/Additional Context
A clear and concise description of any alternative solutions or features you've considered.
Add any other context, links, or screenshots about the feature request here.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/task-tracking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Task tracking
about: Support activities that are not typically code related
title: 'TASK:'
labels: task
assignees: ''

---

## Description
A clear and concise description of the work to be done.

## DOD
Acceptance criteria required to complete the work
- [ ] Using checkboxes helps to communicate progress

## Test Strategy/Script
How will this item be verified?

## References/Additional Context
As needed

0 comments on commit d9309af

Please sign in to comment.