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.

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

#24 Enhancements vs bugs #25

Merged
merged 3 commits into from
Jan 17, 2018
Merged
Changes from all commits
Commits
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
55 changes: 54 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ your team replicate it. Think:
- What pathway did I take to get to the error? ie. who was I logged in as?
:busts_in_silhouette: what was I trying to do when it happened?
- What device or browser was I using? :iphone::computer: e.g. Internet Explorer
v10 or iPhone 6 view.
v10 or iPhone 6 view.

Then take a screenshot of the bug and put it all into an issue to be fixed
:wrench: :sparkles:.
Expand Down Expand Up @@ -150,3 +150,56 @@ The best time for the whole team to start is at the "ideation" or "Design Sprint
stage so that no time is wasted on this on-boarding later on.

Further reading: https://en.wikipedia.org/wiki/Brooks%27s_law

## The lifecycle of an issue

At dwyl we use github labels to help indicate the type, duration and status of an
issue. The following image outlines the lifecycle of an issue using labels. In
this example there are 3 actors, the Product Owner (PO), the dev team
(Scrum Master and developers) and in this case the developer who has completed
the issue: 'Cleop'.

<img src="https://user-images.githubusercontent.com/16775804/35041656-65100b90-fb7d-11e7-8139-15916e7325f7.png" width=350px />

To learn more about our contributing process see: https://github.com/dwyl/contributing.

## When to create a new issue when dealing with bugs 🐛 and enhancements :ribbon:

An existing issue is put into `please-test` as the team have finished working on
it and all of the acceptance criteria have been fulfilled. You, the product
owner test the issue and on reflection you decide that you think the designs
would look better with a couple of tweaks - maybe removing the bold on the
Copy link
Member

Choose a reason for hiding this comment

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

This makes me think that we could probably do with a flow diagram of what an issue goes through and the various actors.

title, making the logo a bit bigger and changing the copy by a few words. What
do you do in this situation?

These changes might relate to the changes made in the issue but if they are
fundamentally not what you asked for in the first place or not what was shown on
the mock-up then they belong in a new issue **NOT** as a 'bug' or as a request
at the bottom of the existing issue. Small as they seem, these issues are
enhancements and new scope and they should be dealt with separately.
Copy link
Member

Choose a reason for hiding this comment

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

We should look to add an example here of what's an enhancement


### Why?
- These kinds of small changes add up, especially if you change your mind a couple
of times or if there are a few across multiple issues.
- The title of the issue may no longer reflect the content inside making it
more complicated for people to follow the chains of conversations.
- The extra changes will impact the developer's initial time estimate
which is damaging for their accuracy when trying to estimate how long issues
will take.
- The extra scope may push something else out of the sprint. Had you prioritised
the changes as a new issue you may not have put this tweak above the other issues
in the sprint.

**Here's an example where a new issue should have been made:**

![image](https://user-images.githubusercontent.com/16775804/35000346-12827d14-fadc-11e7-97da-3921382b2dc2.png)

### So what changes count as bugs :bug: then?
Bugs are places where the acceptance criteria has not been met :negative_squared_cross_mark: :

e.g. you were meant to change the font size across all titles on this page but
you missed out the last title - please can you change it?

I submitted the form but I didn't receive an email notification as specified in
the acceptance criteria. Please can you fix whatever is stopping the email from
being sent?