Jan 18, 2013

Subtle MSF Agile Enhancement: Adding Bugs to the Backlogs

TFS’s Work Item Tracking system is amazing – the flexibility and customizability of the system is fantastic. It also allows your tool to enforce your processes – which is always a good thing for efficiency in any team!

When I install / configure / customize TFS at my customers, I usually suggest that they start with one of the three out-of-the-box Process Templates – CMMI, Scrum or Agile. Then after having run a couple of sprints or iterations using these templates, decide what changes are required and implement them slowly and over time.

So how do you decide which template to start off with? At a very high level, CMMI is the most formal of the templates. Scrum and Agile are very similar in most respects, and I only recommend Scrum for Scrum purists. My template of choice for most teams is the MSF Agile Template.

Scrum vs Agile

Scrum sort-of-noses-ahead-slightly-early-on because:

  • You can see Bugs along with Product Backlog items

Agile comes-from-behind-and-smashes-Scrum-to-smithereens because:

  • The dashboarding and reporting are more comprehensive out-the-box
  • The bug States make more sense
    • In Scrum, Bugs are Approved and Committed – what does that really mean? I prefer Active-Resolved-Closed
    • Scrum Bugs can’t be “resolved” during Check-in because there is no resolved state
    • Scrum Bugs can’t be verified in MTM, since there is no resolved state

So it’s really the dashboards and Bug lifecycle that pushes me to recommending Agile over Scrum.

Bugs in Planning

One of the pain points in the Agile template is planning around bugs. I see two challenges:

  1. You have a Bug that is known, and you plan to fix it in a future Iteration. To do this (including planning time and resources to do the work) you would have to create a User Story that is a “copy” of the Bug so that the User Story can be part of the backlog and you can log tasks against the bug. This does mean some duplication, and in the latest Agile template (6.1) there is a Reason when you transition from “Active” to “Resolved” called "Copied to Backlog” that is designed for this scenario.
  2. You find a Bug during the Sprint and you need to fix it. Again, you’d need to “copy” the Bug to a User Story and add this into the backlog. This will surface as unplanned work, which is what you want.

Of course, you can just fix the bug without the User Story, but then you’ll have to decide where to log the tasks so that they actually appear in the backlogs.

The Solution: Modify Agile Bugs to make them more “Scrummy”

At one of my customers, we made some minor changes to the Agile template that mitigate the “copy Bug to User Story” pain. It allows you to bring the Bugs into the backlogs (just like the Scrum template) so you end up with the best of both Agile and Scrum templates. The only down side is that if you have a lot of bugs, you can end up cluttering your backlogs, but this is a problem you’d have in the Scrum template anyway.

To do this you need to add a New state to the Bug Work Item – that will make the Bug and User Story States match more closely (New, Active, Resolved, Closed). User Stories have an extra “Removed” state, but that’s not required on the Bug. Secondly, you need to add the Bug Work Item to the Requirements Category, allowing the Product Backlog to show Bugs.

Before you start, make sure you backup as you go along (by source controlling your files) and do this on a test TFS Server before attempting this on a production server! If you get the error below, don’t panic. Check your configurations and try again. I wish there was a better description of exactly what is wrong, but unfortunately there doesn’t appear to be any more detail, so you’ll have to revert and try again.

image

Add Story Points and the “New” State to the Bug Work Item

To edit the Bug Work Item, open it using the Process Template editor or from the command line. I’ll show you how to do this from the command line and in the XML itself. I’m going to connect to localhost (my TFS server) to the DefaultCollection and work with a TeamProject called “Code”. Of course you’ll have to change the server, collection and team project name for your scenario.

From a command line, export the Bug Work Item Template:

witadmin exportwitd /collection:http://localhost:8080/tfs/defaultcollection /p:Code /f:Bug.xml /n:Bug


In the <Fields> section, copy the Story Points field from the User Story work item type or just paste in the following:

<FIELD name="Story Points" refname="Microsoft.VSTS.Scheduling.StoryPoints" type="Double" reportable="measure" formula="sum">
<HELPTEXT>The size of work estimated for implementing this user story</HELPTEXT>
</FIELD>

Then look for the “Planning” group in the <Layout> and change it to the following (to add the Story Points control):

<Column PercentWidth="33">
<Group Label="Planning">
<Column PercentWidth="100">
<Control FieldName="Microsoft.VSTS.Scheduling.StoryPoints" Type="FieldControl" Label="Story Points" LabelPosition="Left" />
<Control FieldName="Microsoft.VSTS.Common.StackRank" Type="FieldControl" Label="Stack Rank" LabelPosition="Left" NumberFormat="DecimalNumbers" MaxLength="10" EmptyText="&lt;None&gt;" />
<Control FieldName="Microsoft.VSTS.Common.Priority" Type="FieldControl" Label="Priority" LabelPosition="Left" />
<Control FieldName="Microsoft.VSTS.Common.Severity" Type="FieldControl" Label="Severity" LabelPosition="Left" />
</Column>
</Group>
</Column>

Now edit the <States> and <Transitions> elements of the Bug. You can simply copy/paste the <State value=”Active”> and change the value to “New” to create the New state.

<STATES>
<STATE value="New">
<FIELDS>
...
</FIELDS>
</STATE>
<STATE value="Active">
...
<STATES>

Then in <Transitions> remove the <TRANSITION from="" to="Active"> transition and add the following:

<TRANSITION from="" to="New">
<REASONS>
<DEFAULTREASON value="New" />
<REASON value="Build Failure" />
</REASONS>
</TRANSITION>
<TRANSITION from="New" to="Active">
<REASONS>
<DEFAULTREASON value="Activated" />
</REASONS>
<FIELDS>
<FIELD refname="Microsoft.VSTS.Common.ActivatedBy">
<ALLOWEXISTINGVALUE />
<COPY from="currentuser" />
<VALIDUSER />
<REQUIRED />
</FIELD>
<FIELD refname="Microsoft.VSTS.Common.ActivatedDate">
<SERVERDEFAULT from="clock" />
</FIELD>
</FIELDS>
</TRANSITION>
<TRANSITION from="Active" to="New">
<REASONS>
<DEFAULTREASON value="Deactivated" />
</REASONS>
<FIELDS>
<FIELD refname="Microsoft.VSTS.Common.ActivatedBy">
<EMPTY />
</FIELD>
<FIELD refname="Microsoft.VSTS.Common.ActivatedDate">
<EMPTY />
</FIELD>
</FIELDS>
</TRANSITION>

Now you can import the Work Item Type to make the change to your Bug Work Item:

witadmin importwitd /collection:http://localhost:8080/tfs/defaultcollection /p:Code /f:Bug.xml

Exposing Bugs on the Backlogs


To do this, you need to edit the Categories and the CommonProcessConfiguration. First let’s export those:

witadmin exportcategories /collection:http://localhost:8080/tfs/defaultcollection /p:Code /f:Categories.xml

witadmin exportcommonprocessconfig /collection:http://localhost:8080/tfs/defaultcollection /p:Code /f:CommonProcessConfig.xml


Open Categories.xml and add Bugs to the Requirements Category:

<CATEGORY refname="Microsoft.RequirementCategory" name="Requirement Category">
<DEFAULTWORKITEMTYPE name="User Story" />
<WORKITEMTYPE name="Bug" />
</CATEGORY>

Open CommonProcessConfig.xml and add the “New” state to the mapping:

<BugWorkItems category="Microsoft.BugCategory">
<States>
<State type="Proposed" value="New" />
<State type="InProgress" value="Active" />
<State type="Complete" value="Closed" />
<State type="Resolved" value="Resolved" />
</States>
</BugWorkItems>

Finally, import the Categories and CommonProcessConfig files:

witadmin importcategories /collection:http://localhost:8080/tfs/defaultcollection /p:Code /f:Categories.xml

witadmin importcommonprocessconfig /collection:http://localhost:8080/tfs/defaultcollection /p:Code /f:CommonProcessConfig.xml


The Results


Now you’ll be able to add Bugs on your Product Backlog, as well as do work breakdowns for Bugs in the Sprint Backlog.


image


You’ll probably want to add Work Item Type as a Column to your Product and Iteration Backlogs (press the Column Options button shown in the figure above) or you can also edit the AgileProcessConfig file (works similarly to the CommonProcessConfig – see witadmin exportagileprocessoconfiguration for more details).


image


image


Thanks to my good friend Theo Kleynhans for working with me on this!


Happy (product back-) logging!


UPDATE: If you want to make some subtle changes to your Task Board (including showing the Type of the “Requirement” and the ID of the Work Item) and you don’t mind an unofficial “hack” – then my good friend Tiago Pascoal has a Task Board Plugin – read about it in this post.

1 comment:

  1. Thank you for the provided information. It was very helpful to me!

    ReplyDelete