From c356499e853578d2a844d427ac2c7ebd360a19ba Mon Sep 17 00:00:00 2001 From: robertmitchellv Date: Wed, 30 Oct 2024 14:23:11 -0700 Subject: [PATCH] added team 4 templates to the repo --- .github/ISSUE_TEMPLATE/team4-bug-template.md | 73 +++++++++++++++++++ .../ISSUE_TEMPLATE/team4-spike-template.md | 64 ++++++++++++++++ .github/ISSUE_TEMPLATE/team4-task-template.md | 54 ++++++++++++++ .../team4-user-story-template.md | 67 +++++++++++++++++ 4 files changed, 258 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/team4-bug-template.md create mode 100644 .github/ISSUE_TEMPLATE/team4-spike-template.md create mode 100644 .github/ISSUE_TEMPLATE/team4-task-template.md create mode 100644 .github/ISSUE_TEMPLATE/team4-user-story-template.md diff --git a/.github/ISSUE_TEMPLATE/team4-bug-template.md b/.github/ISSUE_TEMPLATE/team4-bug-template.md new file mode 100644 index 0000000000..9b634ed158 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/team4-bug-template.md @@ -0,0 +1,73 @@ +--- +name: Team 4 ๐Ÿ› Bug Template +about: Capture ๐Ÿ›๐Ÿชฒ๐Ÿœ bugs with this +title: "[BUG] " +labels: team4 +assignees: "" +--- + +<!-- +Note: Please search to see if an issue already exists for the bug you encountered. +--> + +## ๐Ÿ“œ Description + +<!-- +Provide a high-level summary of the bug and what impact it has +--> + +## ๐Ÿ‘ฃ Steps to reproduce + +<!-- +List out the steps in detail to reproduce the bug + +Example: steps to reproduce the behavior: +1. In this environment... +1. With this config... +1. Run '...' +1. See error... +--> + +1. ... + +## ๐ŸŒƒ Environment: + +<!-- +Example: +- OS: Ubuntu 20.04 +- Node: 13.14.0 +- npm: 7.6.3 +--> + +- OS: +- ... + +## ๐Ÿซด Expected Result + +<!-- +Explain how it should function if the bug was fixed. Attach screenshot if applicable +--> + +## ๐Ÿงช Actual result + +<!-- +Explain what's happening now when the bug is present. Attach screenshot if applicable +--> + +## ๐Ÿšฆ Priority + +<!-- +Provide an estimate for level of impact the bug has today by placing an `X` in the applicable bracket +--> + +#### Priority + +- [ ] **Low priority** _The bug does not have to be fixed immediately. High and medium priority bugs should be addressed first._ +- [ ] **Medium priority** _Typically, medium-priority bugs do not affect customers directly and therefore can be fixed in the normal course of testing and development._ +- [ ] **High priority** _High priority bugs must be addressed immediately. They often affect the appโ€™s functionality and impact customers and their user experience. They must take priority._ + +## ๐Ÿ““ Notes + +<!-- +Include any additional context or information here that doesn't fit into other parts of the template +--> diff --git a/.github/ISSUE_TEMPLATE/team4-spike-template.md b/.github/ISSUE_TEMPLATE/team4-spike-template.md new file mode 100644 index 0000000000..a5bbf5e3c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/team4-spike-template.md @@ -0,0 +1,64 @@ +--- +name: Team 4 ๐Ÿ“š๐Ÿ““ Spike Template +about: Used for exploratory engineering spikes ๐Ÿ“š๐Ÿ““ +title: "[SPIKE] <title>" +labels: team4 +assignees: "" +--- + +## ๐Ÿšง What needs to be done + +<!-- +Provide a summary of the task that needs to be completed and its context +--> + +## ๐Ÿค” Why it needs to be done + +<!-- +Describe the importance or impact of completing this task +--> + +## โฐ Timebox + +<!-- +How much time should be dedicated to this spike? +--> + +## ๐Ÿ“ To-do list + +<!-- +List out actions to be taken for this spike to help others follow your progress + +Example: +- [X] Define objectives and goals + - [X] Document the goals and questions this spike aims to address + - [X] Confirm goals with the team/product lead if needed +- [X] Research + Analysis + - [X] Gather resources (documentation, tools, relevant code samples) + - [X] Review existing solutions and identify potential tools + - [X] Document pros and cons of each tool for comparison +- [X] Prototype Development (if applicable) + - [X] Create a basic prototype to test chosen tool(s) on sample or test data + - [X] Document any issues or limitations found during prototyping +- [ ] Documentation of Findings +- [ ] Review and Finalize +--> + +- [ ] Define objectives and goals + - [ ] ... +- [ ] Research + Analysis + - [ ] ... +- [ ] Prototype Development (if applicable) + - [ ] ... +- [ ] Documentation of Findings + - [ ] ... +- [ ] Review and Finalize + - [ ] ... + +## ๐Ÿ“œ Additional context + +<!-- +Optional, delete if not needed + +Include any additional context or information here that doesn't fit into other parts of the template +--> diff --git a/.github/ISSUE_TEMPLATE/team4-task-template.md b/.github/ISSUE_TEMPLATE/team4-task-template.md new file mode 100644 index 0000000000..4cdf30997f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/team4-task-template.md @@ -0,0 +1,54 @@ +--- +name: Team 4 ๐Ÿ‘ท Task Template +about: A generic template for any task that can be adapted for multiple uses +title: "[TASK] <title>" +labels: team4 +assignees: "" +--- + +## ๐Ÿšง What needs to be done + +<!-- +Provide a summary of the task that needs to be completed +--> + +## ๐Ÿค” Why it needs to be done + +<!-- +Describe the importance or impact of completing this task +--> + +## ๐Ÿ—๏ธ Acceptance Criteria + +<!-- +List out all expected functionality/requirements + +Example using Given-When-Then: +- **Given** describes the initial context or state of the system (preconditions) +- **When** specifies the action or trigger that occurs +- **Then** defines the expected outcome or result +--> + +- **Given** +- **When** +- **Then** + +## โš™๏ธ Technical Notes + +<!-- +Owned by eng team - write out any important technical considerations such as: architecture plan/notes, data dependencies, testing plan, etc. Also link any tickets that are dependent on or related to this task + +Example: +- Architecture Plan/Notes + - This feature will integrate with the existing **Service** and will require updates to the **API Gateway** to expose new endpoints +--> + +- ... + +## ๐Ÿ“œ Additional context + +<!-- +Optional, delete if not needed + +Include any additional context or information here that doesn't fit into other parts of the template +--> diff --git a/.github/ISSUE_TEMPLATE/team4-user-story-template.md b/.github/ISSUE_TEMPLATE/team4-user-story-template.md new file mode 100644 index 0000000000..bbede0c679 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/team4-user-story-template.md @@ -0,0 +1,67 @@ +--- +name: Team 4 ๐Ÿ‘ค๐Ÿ’ญ User Story Template +about: Create a new user story for Team 4 +title: "[USER STORY] <title>" +labels: team4 +assignees: "" +--- + +## ๐Ÿ‘ค๐Ÿ’ญ User Story + +<!-- +As a [user/persona], I want to [do a thing], so that I can [achieve a goal/outcome] +--> + +## ๐Ÿ—๏ธ Acceptance Criteria + +<!-- +List out all expected functionality/requirements + +Example using Given-When-Then: +- **Given** describes the initial context or state of the system (preconditions) +- **When** specifies the action or trigger that occurs +- **Then** defines the expected outcome or result +--> + +- **Given** +- **When** +- **Then** + +## ๐ŸŽฌ Scenarios + +<!-- +Write out scenarios that will help to ensure the functionality works as expected + +For example, this could look like: +- I click on the Score filter and a dropdown appears showing a slider. +- โ€œ1โ€ and โ€œ10โ€ are selected by default. The submit button is disabled. +- I then drag the left slider to โ€œ6โ€ making the score 6 to 10. +- The text input below updates to display โ€œ6โ€ and submit button is now active. +- I click submit and the dropdown closes. +- My search results are now updated. +--> + +- ... + +## ๐ŸŽจ Design Notes + +<!-- +Owned by design team - Attach link to design in dev mode and/or prototype, as well as any notes on visual details, interaction expectations, accessibility considerations, copy requirements + +[Link to Figma design in Dev mode]() +[Link to Figma prototype]() +--> + +- ... + +<!-- +Screenshots below should not be used for working on this ticket - always refer to Figma design for most up-to-date designs: +--> + +## ๐Ÿ“œ Additional context + +<!-- +Optional, delete if not needed + +Include any additional context or information here that doesn't fit into other parts of the template +-->