From 0a65d81db195e04354aae47cf5a6b91cda837b4f Mon Sep 17 00:00:00 2001 From: Nyra Sama <83142634+NyraSama@users.noreply.github.com> Date: Tue, 4 Jun 2024 12:00:17 +0200 Subject: [PATCH] feat(issue_templates): Add new templates and archive old templates (#1486) --- .../{ => archive}/bug_report.md | 0 .../{ => archive}/dor_issue_template.md | 0 .../{ => archive}/feature_request.md | 0 .github/ISSUE_TEMPLATE/bug_template.md | 62 ++++++++++++++++ .github/ISSUE_TEMPLATE/issue_template.md | 74 +++++++++++++++++++ .github/ISSUE_TEMPLATE/ui_element_template | 73 ++++++++++++++++++ 6 files changed, 209 insertions(+) rename .github/ISSUE_TEMPLATE/{ => archive}/bug_report.md (100%) rename .github/ISSUE_TEMPLATE/{ => archive}/dor_issue_template.md (100%) rename .github/ISSUE_TEMPLATE/{ => archive}/feature_request.md (100%) create mode 100644 .github/ISSUE_TEMPLATE/bug_template.md create mode 100644 .github/ISSUE_TEMPLATE/issue_template.md create mode 100644 .github/ISSUE_TEMPLATE/ui_element_template diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/archive/bug_report.md similarity index 100% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/archive/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/dor_issue_template.md b/.github/ISSUE_TEMPLATE/archive/dor_issue_template.md similarity index 100% rename from .github/ISSUE_TEMPLATE/dor_issue_template.md rename to .github/ISSUE_TEMPLATE/archive/dor_issue_template.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/archive/feature_request.md similarity index 100% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/archive/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_template.md b/.github/ISSUE_TEMPLATE/bug_template.md new file mode 100644 index 000000000..1125a6d9f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_template.md @@ -0,0 +1,62 @@ +--- +name: Bug report +about: Help us improve your experience. +title: '' +labels: '' +assignees: '' + +--- + +# 🗒️NOTES + +Anything relevant to the issue's state or any additional description. + +# 🏁MILESTONES + +- [ ] **DOR** +- [ ] **DOD** + +# 📜CONTEXT (User Story) + +***As a*** dev/admin/user + +***I want*** to develop/manage/use + +***In order*** to work + +# 🪳STEPS TO REPRODUCE + +- Step 1: Step 1 +- Step 2: Step 2 +- Step 3: Step 3 + + +# 🪜STEPS FOR A FIX + +- [ ] Step 1: +- [ ] Step 2: +- [ ] Step 3: +... + + +# ✅ACCEPTANCE CRITERIA + +- ⛔Acceptance criterion not-met +- ✅Acceptance criterion met + + +# 📛BLOCKERS + +- 📛Blocker still present +- ~~Blocker dealt with~~ + +# 🔍AFFECTED COMPONENT(S) (Scope) + +/src/… + +# ⛓️LINK TO OTHER ISSUES +(Insert links here) + +# 🪟SCREEN SHOTS & MOCKUPS + +Here you can insert screen shots, pictures or figma links pointing to a visual representation of what is expected diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md new file mode 100644 index 000000000..b90247cb7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template.md @@ -0,0 +1,74 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +# 🗒️NOTES + +Anything relevant to the issue's state or any additional description. + +# 🏁MILESTONES + +- [ ] **DOR** +- [ ] **DOD** + +# 📜CONTEXT (User Story) + +***As a*** dev/admin/user + +***I want*** to develop/manage/use + +***In order*** to work + +# 🪜STEPS TO FOLLOW + +- [ ] Step 1: +- [ ] Step 2: +- [ ] Step 3: +... + +# 🪳STEPS TO REPRODUCE (If it is a bug) + +- Step 1: Step 1 +- Step 2: Step 2 +- Step 3: Step 3 + +# ✅ACCEPTANCE CRITERIA + +- ⛔Acceptance criterion not-met +- ✅Acceptance criterion met + +# 📛BLOCKERS + +- 📛Blocker still present +- ~~Blocker dealt with~~ + +# 🔍AFFECTED COMPONENT(S) (Scope) + +/src/… + +# ⛓️LINK TO OTHER ISSUES +(Insert links here) + +# 🪟SCREEN SHOTS & MOCKUPS + +Here you can insert screen shots, pictures or figma links pointing to a visual representation of what is expected + +# 📋TEST STATUSES +What are the test cases required to validate this issue? +- [ ] Test case 1: +- [ ] Test case 2: +- [ ] Test case 3: +- [ ] ... + +What kind of tests has been put in place to ensure the issue is resolved? +- [ ] Manual Tests +- [ ] Unit Tests +- [ ] Integration Tests +- [ ] Functional Tests +- [ ] End To End Tests +- [ ] Other (elaborate) diff --git a/.github/ISSUE_TEMPLATE/ui_element_template b/.github/ISSUE_TEMPLATE/ui_element_template new file mode 100644 index 000000000..4629a8e74 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ui_element_template @@ -0,0 +1,73 @@ +--- +name: UI Element request +about: Need a visual component/widget? +title: '' +labels: '' +assignees: '' + +--- + +# 🗒️NOTES + +Anything relevant to the issue's state or any additional description. + +# 🏁MILESTONES + +- [ ] **DOR** +- [ ] **DOD** +- [ ] **Validation with end users** +- [ ] **Validation with product director** +- [ ] **DOD** + +# 📜CONTEXT (User Story) + +***As a*** dev/admin/user + +***I want*** to develop/manage/use + +***In order*** to work + +# 🪜STEPS TO FLLOW + +- [ ] Step 1: +- [ ] Step 2: +- [ ] Step 3: +... + + +# ✅ACCEPTANCE CRITERIA + +- ⛔Acceptance criterion not-met +- ✅Acceptance criterion met + + +# 📛BLOCKERS + +- 📛Blocker still present +- ~~Blocker dealt with~~ + +# 🔍AFFECTED COMPONENT(S) (Scope) + +/src/… + +# ⛓️LINK TO OTHER ISSUES +(Insert links here) + +# 🪟SCREEN SHOTS & MOCKUPS + +Here you can insert screen shots, pictures or figma links pointing to a visual representation of what is expected + +# 📋TEST STATUSES +What are the test cases required to validate this issue? +- [ ] Test case 1: +- [ ] Test case 2: +- [ ] Test case 3: +- [ ] ... + +What kind of tests has been put in place to ensure the issue is resolved? +- [ ] Manual Tests +- [ ] Unit Tests +- [ ] Integration Tests +- [ ] Functional Tests +- [ ] End To End Tests +- [ ] Other (elaborate)