From d9309af501c0bd74c613a79536859a6279c59d10 Mon Sep 17 00:00:00 2001 From: Nicholas Artieri <131482695+nartieri@users.noreply.github.com> Date: Thu, 23 May 2024 16:35:44 -0400 Subject: [PATCH] #91 Create Github Issue Templates (#101) * Create Github Issue Templates Creating issue templates to engender consistency when creating Github Issues. * Update bug_report.md Changed ordering of description sections. --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++++++++++++++ .github/ISSUE_TEMPLATE/task-tracking.md | 21 ++++++++++++++++ 3 files changed, 73 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/task-tracking.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..9aac01167 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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.) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..224c421ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/task-tracking.md b/.github/ISSUE_TEMPLATE/task-tracking.md new file mode 100644 index 000000000..a4c413a96 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task-tracking.md @@ -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