Update new feature template to add user story requirement #2166
Conversation
|
This is a mixed PR? was it intentional? |
|
Ugh no, I need to fix that |
ZeLonewolf
force-pushed
the
zlw-user-story-template
branch
from
42558b0 to
bf5eed1
Compare
|
Fixed with clean commit history, sorry about that. |
|
No worries 😀 |
|
Any chance to split this to two github buttons while you are at it? Bugs and features? |
In leading agile teams, I've always struggled with standard formats for reporting bugs. If you've been diligent in creating user stories for every feature (basically no team in the real world actually accomplishes this), then you can say "link the user story broken by this bug". So I'm not sure if describing a bug in user story format is really the right concept. You already have expected behavior and actual behavior sections. Perhaps consider moving those two sections to the very top of the bug report would be better? |
|
I meant to say to create two different templates, one for bug and the other feature. Sorry if that wasn't clear. |
There are already separate templates for bugs and features: This PR was specifically addressing a deficiency in the new feature template. However, if I were to simplify the new feature template, it might look something like:
The other sections of the new feature template seem more appropriate to an implementation/PR discussion |
|
This sounds better than the current complicated template, feel free to change it. |
|
Updated template as discussed. |
| --> | ||
|
|
||
| ## Design | ||
| As a <role> I can <capability>, so that <receive benefit> |
There was a problem hiding this comment.
Won't these "<" disappear due to markdown stuff?
There was a problem hiding this comment.
It's all within the <!-- --> HTML comment blocks so everything within will disappear if not edited.
User Story
As a developer I want to provide useful information to the maintainer team in order that I clearly describe the reason for desired code changes.
Motivation
In #2162 (comment), it was described that there's an undocumented expectation for issue authors to provide a user story which succinctly describes the purpose of the requested change. This PR formally adds that expectation explicitly in the issue template. This will assist authors of new feature tickets in better communicating what they are trying to accomplish.
Sorry for going straight to PR but I felt this was a simple enough change.