From 5f192d865c6bf4aadf9e7e16581e602b9e0371f2 Mon Sep 17 00:00:00 2001 From: Taush Sampley Date: Mon, 16 Sep 2024 10:22:54 -0500 Subject: [PATCH 1/4] replace user requirements with system requirements format --- .github/ISSUE_TEMPLATE/enhancement.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md index 03ac6d1..16638d4 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -10,11 +10,12 @@ assignees: '' # User Story As a <role>, I want <to action or feature>, so that <value>. -## Requirements -Itemize user requirements +## Acceptance Criteria -* <descriptions> +- Given <initial condition> + - When <event or action> + - Then <expectation> ## References -* <images or additional imformation> +* <links, images, or thought process> From d7398da657b5febcaa948d644155b04e37753acd Mon Sep 17 00:00:00 2001 From: Taush Sampley Date: Mon, 16 Sep 2024 10:39:15 -0500 Subject: [PATCH 2/4] Add simple task ticket --- .github/ISSUE_TEMPLATE/task.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/task.md diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md new file mode 100644 index 0000000..ba84d4f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.md @@ -0,0 +1,11 @@ +--- +name: Task +about: Small work item that may be awkward to state as a user story - usually a technical task in support of a feature or bug fix. +title: "[TASK] " +labels: enhancement +assignees: '' + +--- + +# Discussion +<A title is often sufficient for small tasks, but please include discussion notes related to potential implementation.> From dab1aff2e9ab1fb370b160026257eb4b93545273 Mon Sep 17 00:00:00 2001 From: Taush Sampley Date: Mon, 16 Sep 2024 10:55:37 -0500 Subject: [PATCH 3/4] reformat bug report --- .github/ISSUE_TEMPLATE/bug_report.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3a4ec68..7014d36 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -17,16 +17,15 @@ Platform - tag as Android, iOS, Web, or Desktop | App Version | (1.0) | ## Description -Clear concise description of the bug: +<Clear, concise description of the bug> ## Reproduction Steps -Steps to reproduce the bug: 1. <Action/Step> -2. +2. ### Expected ### Actual ## References -Screenshots or additional information +<Original Report or other information - design images or screenshots should be placed under expected or actual> From 7b3be1426d135872762212cddddfdecfcfe50d96 Mon Sep 17 00:00:00 2001 From: Taush Sampley Date: Mon, 16 Sep 2024 11:11:07 -0500 Subject: [PATCH 4/4] Add pull request templates --- .github/PULL_REQUEST_TEMPLATE/bug_fix.md | 11 +++++++++++ .github/PULL_REQUEST_TEMPLATE/enhancement.md | 9 +++++++++ 2 files changed, 20 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/bug_fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/enhancement.md diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md new file mode 100644 index 0000000..0c160cc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md @@ -0,0 +1,11 @@ +# Description +<Describe the bug fix in detail. Include any relevant information that may help the reviewer understand the context of the change.> + +Resolves: +- #<issue number> + +## Investigation and Findings +<Describe the investigation process and findings.> + +## Check list +- [ ] Regression Tests Written diff --git a/.github/PULL_REQUEST_TEMPLATE/enhancement.md b/.github/PULL_REQUEST_TEMPLATE/enhancement.md new file mode 100644 index 0000000..40e1b33 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/enhancement.md @@ -0,0 +1,9 @@ +# Description +<Describe the enhancement or feature modification in detail. Include any relevant information that may help the reviewer understand the context of the change.> + +Resolves: +- #<issue number> + +## Check list +- [ ] Tests Written +- [ ] Documentation Updated