-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #637 from alan-turing-institute/chrisdburr-patch-1
Update user-story.yaml
- Loading branch information
Showing
1 changed file
with
27 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,86 +1,48 @@ | ||
name: User Story | ||
description: Create a new user story. | ||
title: "[User Story]: " | ||
labels: ["user-story"] | ||
name: "User Story" | ||
description: "Template for creating user stories in this repository" | ||
labels: "user-story" | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for contributing a new user story! Please fill out the details below to help us understand your vision. | ||
- type: input | ||
id: role | ||
id: user_role | ||
attributes: | ||
label: Role | ||
description: Who is the user for this story? | ||
placeholder: ex. As a [Admin] | ||
label: "User Role" | ||
description: "As a [type of user]" | ||
placeholder: "e.g., Admin, Customer, Developer" | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: feature | ||
id: goal | ||
attributes: | ||
label: Desired Feature | ||
description: What is the feature you would like to have? | ||
placeholder: I want to [feature description] | ||
label: "Goal / Desire" | ||
description: "I want [some goal or desire]" | ||
placeholder: "e.g., view user activity, manage settings" | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: benefit | ||
attributes: | ||
label: Benefit | ||
description: What is the benefit of this feature? | ||
placeholder: So that I can [benefit description] | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: acceptance-criteria | ||
attributes: | ||
label: Acceptance Criteria | ||
description: Please describe the conditions that must be met for this story to be considered complete. | ||
placeholder: | | ||
**GIVEN** [precondition] | ||
**AND** [another precondition if necessary] | ||
**WHEN** [action taken by the user] | ||
**THEN** [expected outcome] | ||
**AND** [another outcome if necessary] | ||
label: "Benefit / Reason" | ||
description: "So that [some benefit]" | ||
placeholder: "e.g., improve productivity, ensure data security" | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: dependencies | ||
- type: checkboxes | ||
id: acceptance_criteria | ||
attributes: | ||
label: Dependencies | ||
description: Are there any other tasks that need to be completed first? | ||
placeholder: | | ||
- [ ] Dependency 1 (include issue link) | ||
- [ ] Dependency 2 (include issue link) | ||
validations: | ||
required: false | ||
label: "Acceptance Criteria" | ||
description: "Define criteria for successful implementation. Check all that apply." | ||
options: | ||
- label: "Criterion 1" | ||
- label: "Criterion 2" | ||
- label: "Criterion 3" | ||
|
||
- type: textarea | ||
id: technical-notes | ||
attributes: | ||
label: Technical Notes | ||
description: Any technical notes, potential challenges, or architectural considerations for implementation? | ||
placeholder: | | ||
- Note 1 | ||
- Note 2 | ||
validations: | ||
required: false | ||
|
||
- type: checkboxes | ||
id: definition-of-done | ||
id: additional_notes | ||
attributes: | ||
label: Definition of Done | ||
description: Please confirm the following are completed before this story can be considered done. | ||
options: | ||
- label: The feature fulfills all acceptance criteria. | ||
- label: The code is reviewed and meets team coding standards. | ||
- label: All unit, integration, and end-to-end tests are passed. | ||
- label: The feature meets accessibility standards set for the project. | ||
- label: The code passes the CI/CD pipeline quality controls (style and linting). | ||
- label: The feature is merged into the main branch. | ||
- label: The feature is deployed and functional in the QA environment. | ||
- label: The feature was demonstrated to the team and accepted by the product owner. | ||
label: "Additional Notes / Considerations" | ||
description: "Any additional context, links, screenshots, or other relevant information" | ||
placeholder: "Add any extra notes here" |