Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the user story template. #235

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update the user story template. #235

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 27 additions & 13 deletions .github/ISSUE_TEMPLATE/user-story.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,40 @@ assignees: ''

---

### Description
### Description

<!-- role details / capability details / value details -->
As <role> I want <capability> so I can <value>
<!-- For you!
Please provide a concise description of what this story is about.
The story should contain the following information:
* Who is going to need this? What role can you identify? Try to be as specific as possible. It helps us to understand the need.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What role can you identify?

What do you mean by that?

Copy link
Contributor Author

@rrahn rrahn Nov 12, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is necessary to think about how important this item is so that we can better prioritise the work.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just wanted to point out that role is very vague. If you add the sentence that you wrote "think about how important this item is so that we can better prioritise the work." is much more precise and helpful :)

* What would you like to have? Add as much information as possible so we can understand the problem at any time.
* How does it benefit your work? This helps us to understand the value of the story and how to prioritise the work.

To help you formulating your story you can use one of the following phrases:
* As <role> I want <capability> so I can <value>
* <action> the <result> <by|for|of|to> a(n) <object>
-->

### Acceptance Criteria

<!-- All the stuff that needs to be done, besides the Definition of Done for this story. -->
<!-- For Triage!
Copy link
Member

@smehringer smehringer Nov 16, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the Triage phase again?

This section is filled later when the story is in triage:
* Ask all relevant questions to understand the functionality, its dependencies and implications.
* Estimate the work and split if necessary.
* Define specifications in form of testable acceptance criteria.

- [ ] test 1
- [ ] test 2
- [ ] test 3
In triage phase it is important to ask all relevant questions about the story such that everyone understands the functionality of the story, as well as its implications and dependencies. The story will then be estimated and possibly split into smaller components. Further, the triage team has to write down the story specifications in form of acceptance criteria that need to be tested. After completing the triage phase the issue will be handed to the dev team.
-->

### Tasks

<!-- The tasks which need to be tackled for this story to be completed. They are likely to be defined later when the team plans this story for the next iteration and discusses the design. -->
<!-- For Development!
This section is filled by the development team to specify the concrete tasks to solve the story.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Who are these teams? triage team, development team?
Is one of them the Core team?

Also update the Definition of Done accordingly.
-->

- [ ] task 1
- [ ] task 2
- [ ] task 3

### Definition of Done
<details><summary>Definition of Done</summary>
<p>

- [ ] Implementation and design approved
- [ ] Unit tests pass
Expand All @@ -39,3 +50,6 @@ As <role> I want <capability> so I can <value>
- [ ] Tutorial/teaching material added
- [ ] Test suite compiles in less than 30 seconds (on travis)
- [ ] Changelog entry added

</p>
</details>