Επεξεργασία

Κοινή χρήση μέσω

Define, capture, triage, and manage software bugs in Azure Boards

  • Άρθρο

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

How do you track and manage defects in your code? How do you make sure software problems and customer feedback get addressed quickly to support high-quality software deployments? How do you make good progress on new features and address your technical debt?

At a minimum, you need a way to capture your software issues, prioritize them, assign them to a team member, and track progress. You want to manage your code defects in ways that align with your Agile practices.

To support these scenarios, Azure Boards provides a specific work item type to track code defects named Bug. Bug work items share all the standard features of other work item types with a few more. For an overview of standard features, see About work items and work item types.

Bugs also provide the following features:

  • Options for each team to choose how they want to track bugs
  • Test tools to capture bugs
  • Built-in integration across Azure DevOps to track bugs linked to builds, releases, and tests

Note

Bug work item types aren't available with the Basic process. The Basic process tracks bugs as Issues and is available when you create a new project from Azure DevOps Services or Azure DevOps Server 2019.1 or later versions.

Prerequisites

  • Project access: Be added to a project.

  • Permissions:

    • Have View work items in this node and Edit work items in this node permissions set to Allow. By default, the Contributors group has these permissions. For more information, see Set work tracking permissions.

    • To add new tags to work items, have Basic access or higher and the project-level Create new tag definition permission set to Allow. By default, the Contributors group has this permission.

      Note

      Stakeholders cannot add new tags, even if the permission is explicitly set, due to their access level. For more information, see Stakeholder access quick reference.

  • Email work items: All project members, including those in the Readers group, can send emails containing work items.

Tip

To report a bug, a user must have at a minimum, Stakeholder access. A user must have Edit work items in this node permission set to Allow for the Area Path where they add the bug. For more information, see Set work tracking permissions

Bug work item type

The following image shows the Bug work item type for the Scrum process. The Bug work item type for Agile and Capability Maturity Model Integration (CMMI) processes tracks similar information. It appears on the product backlog along with requirements or on the Taskboard along with tasks.

Note

The images you see from your web portal might differ from the images you see in this article. These differences result from updates made to your web app, options that you or your administrator enabled, and which process was chosen when creating your project: Agile, Basic, Scrum, or CMMI. The Basic process is available with Azure DevOps Server 2019 Update 1 and later versions.

Screenshot shows a Bug work item type form for Scrum process in Azure DevOps Server 2019.

Fields specific to bugs

The Bug work item type uses some bug-specific fields. To capture both the initial issue and ongoing discoveries, use the fields described in the following table. For information about fields specific to the Bug defined for the Capability Maturity Model Integration (CMMI) process, see Bugs, issues, and risks field reference. For information about all other fields, see Work item field index.

Field, Group, or Tab

Usage

Steps to Reproduce (friendly name=Repro Steps)

Use to capture enough information so that other team members can fully understand the code defect. Include actions taken to find or reproduce the bug and expected behavior.

System Info Found In Build

Information about the software and system configuration that is relevant to the bug and tests to apply. The System Info and Found in Build fields are automatically filled in when you create a bug through a testing tool. These fields specify information about the software environment and build where the bug occurred. For more information, see Test different configurations.

Acceptance Criteria

Provide the criteria to meet before the bug can be closed. Before work begins, describe the customer acceptance criteria as clearly as possible. Teams should use this criteria as the basis for acceptance tests and to evaluate whether an item is satisfactorily completed.

Integrated in Build

Specifies the name of the build that incorporates the code that fixes the bug. This field should be specified when you resolve the bug.

For on-premises Azure DevOps, to access a dropdown menu of all builds that have run, you can update the FIELD definitions for Found in Build and Integrated in Build to reference a global list. The global list is automatically updated with each build that is run. For more information, see Query based on build and test integration fields.

For information about how to define build numbers, see Classic pipelines configuration.

Priority1

  • 1: Product requires successful resolution of the work item before it ships and addressed soon.
  • 2: Product requires successful resolution of the work item before it ships, but doesn't need to be addressed immediately.
  • 3: Resolution of the work item is optional, based on resources, time, and risk.

Severity1

A subjective rating of the impact of a bug or work item on the project or software system. For example: If a remote link within the user interface (a rare event) causes an application or web page to crash (a severe customer experience), you might specify Severity = 2 - High and Priority = 3. Allowed values and suggested guidelines are:

  • 1 - Critical: Must fix. A defect that causes termination of one or more system components or the complete system, or causes extensive data corruption. There are no acceptable alternative methods to achieve required results.
  • 2 - High: Consider fix. A defect that causes termination of one or more system components or the complete system, or causes extensive data corruption. An acceptable alternative method exists to achieve required results.
  • 3 - Medium: (Default) A defect that causes the system to produce incorrect, incomplete, or inconsistent results.
  • 4 - Low: A minor or cosmetic defect that has acceptable workarounds to achieve required results.

Deployment

The Deployment control supports links to and display of releases that contain work items. To use the control, you must enable settings for the release. For more information, see Link work items to releases later in this article.

Development

The Development control supports links to and display of links made to development objects. These objects include Git commits and pull requests, or TFVC changesets and versioned items. You can define links from the work item or from the commits, pull requests, or other development objects. For more information, see Link work items to development later in this article.

Notes

1 To change the menu selection or picklist, see Customize the work tracking experience. The customization method depends on the process model used by your project.

Choose how your team tracks bugs

Your team can track bugs as requirements or as tasks. To support the team choice, consider the following factors.

  • Size of your team. Smaller teams can maintain a lightweight footprint by tracking bugs as requirements.
  • Organization requirements to track work. If your team is required to track hours, then choose to track bugs as tasks.
  • Organization of your team's work. If your team relies on the product backlog to prioritize work and add bugs, track bugs as requirements.
  • Tools your team wants to use such as the Planning pane, velocity chart, forecast, rollup, and delivery plans. Tracking bugs as tasks prevents use of several of these tools.

The following table summarizes the three options teams have to track bugs. To learn more and to set the option for your team, see Show bugs on backlogs and boards.

Option

Choose when you want to...

Track bugs as Requirements

Note

  • Bugs are assigned to the Requirements Category

Track bugs as Tasks

  • Estimate work for bugs similar to tasks
  • Update bug status on sprint Taskboards
  • Link bugs to requirements as child items
  • Drag bugs to the Planning pane to assign bugs to a sprint

Note

  • Bugs are assigned to the Task Category
  • User Stories (Agile), Product Backlog Items (Scrum), or Requirements (CMMI) are the natural parent work item type for Bugs
  • Bugs aren't visible on Delivery Plans

Bugs don't appear on backlogs or boards

  • Manage bugs using queries

Note

  • Bugs are associated with the Bugs Category and don't appear on either backlogs or boards
  • Bugs aren't visible on Backlogs, Boards, Sprint Backlogs, Taskboards, or Delivery Plans
  • You can't drag bugs to the Planning pane to assign bugs to a sprint

Customize work item type

You can customize the Bug and other work item types. Or, create custom types to track software issues or customer feedback. For all work item types, you can customize the following elements:

  • Add or remove custom fields
  • Add custom controls or custom tabs within the work item form
  • Customize the workflow states
  • Add conditional rules
  • Choose the backlog level in which work items appear

Before you customize your process, we recommend that you review About configuring and customizing Azure Boards.

To customize your particular process, see Customize an inheritance process.

Add or capture bugs

You can define bugs from several different Azure DevOps tools. These tools include backlogs and boards and testing tools.

Tip

By default, the Title field is the only required field when you create a bug. You can add bugs in the same way you add user stories or product backlog items using Azure Boards. You can make some fields required by adding conditional rules based on a state change. For more information, see Add a rule to a work item type.

Add a bug from your backlog or board

If your team chose to manage bugs with requirements, you can define bugs from your product backlog or board. For more information, see Create your product backlog or Use your board.

  • Add a bug from the product backlog

    Screenshot shows adding a bug from the product backlog.

  • Add a bug from the board

    Screenshot shows adding a bug from the board.

Tip

When you add a bug from your product backlog or board, the bug is automatically assigned the default Area Path and Iteration Path defined for the team. For more information, see Team defaults referenced by backlogs and boards.

Add a bug from your sprint backlog or Taskboard

If your team chose to manage bugs with tasks, you can define bugs from your board, product backlog, Sprint backlog, or Sprint Taskboard. You add a bug as a child to a product backlog work item.

  • Add a linked child bug from the Sprint Backlog

    You add a bug in the same way you add a task to a Sprint backlog. For more information, see Add tasks to backlog items.

    Screenshot shows adding a linked child bug from the product backlog.

  • Add a linked child bug from the board

    You add a bug in the same way you add a task to a backlog item. For more information, see Add tasks or child items as checklists.

    Screenshot shows adding a lined child bug from the board.

Create a bug from a testing tool

The two testing tools you can use to add bugs while testing include the web portal Test Runner and the Test & Feedback extension.

Bug lifecycle and workflow states

As with all other work item types, the Bug work item type has a well-defined workflow. Each workflow consists of three or more States and a Reason. Reasons specify why the item transitioned from one State to another. The following images illustrate the default bug workflow defined for the Agile, Scrum, and CMMI processes.

Agile Scrum CMMI
Diagram shows the bug workflow states in the Agile process template. Diagram shows the bug workflow states in the Scrum process template. Diagram shows the bug workflow states in the CMMI process template.

For Scrum bugs, you change the State from Committed (similar to Active) to Done. For Agile and CMMI, you first resolve the bug and select a reason that indicates the bug is fixed. Typically, the person who created the bug then verifies the fix and updates the State from Resolved to Closed. If you find more work after you resolve or close a bug, reactivate it by setting the State to Committed or Active.

Note

The Agile process bug work item type previously had a rule which reassigned the bug to the person who created it. This rule has been removed from the default system process. You can reinstate this automation by adding a rule. For an Inheritance process, see Automate reassignment based on state change.

Verify a fix

To verify a fix, a developer or tester attempts to reproduce the bug and look for more unexpected behavior. If necessary, they should reactivate the bug.

When verifying a bug fix, you might find that the bug wasn't fixed or you might disagree with the resolution. In this case, discuss the bug with the person who resolved it, come to an agreement, and possibly reactivate the bug. If you reactivate a bug, include the reasons for reactivating the bug in the bug description.

Close a bug

You close a bug when a team member verifies it as fixed. However, you might also close a bug for one of the following reasons. Reasons available depend on the project process and the bug transition states.

Agile process:

  • Deferred: Defer bug fix until the next product release.
  • Fixed: Bug is verified as fixed.
  • Duplicate: Bug tracks another bug currently defined. You can link each bug with the Duplicate/Duplicate of link type and close one of the bugs.
  • As Designed: Feature works as designed.
  • Cannot Reproduce: Tests prove that the bug can't be reproduced.
  • Obsolete: The bug's feature is no longer in the product.
  • Copied to Backlog: A user story has been opened to track the bug.

Scrum process:

  • Not a Bug: Bug is verified that it isn't a bug.
  • Duplicate: Bug tracks another bug currently defined. You can link each bug with the Duplicate/Duplicate of link type and close one of the bugs.
  • Removed from the backlog: Bug is verified that it isn't a bug. Remove the bug from the backlog.
  • Work finished: Bug has been verified as fixed.

CMMI process:

  • Deferred: Defer bug fix until the next product release.
  • Duplicate: Bug tracks another bug currently defined. You can link each bug with the Duplicate/Duplicate of link type and close one of the bugs.
  • Rejected: Bug is verified that it isn't a bug.
  • Verified: Bug is verified as fixed.

Tip

After a bug has been closed and the fix is actively released in deployments, recommended practice is to never reopen it due to regression. Instead, you should consider opening a new bug and link to the older, closed bug.

It's always a good idea to describe any more details for closing a bug in the Discussion field to avoid future confusion as to why the bug was closed.

Automate bug closure when merging pull requests

If your team uses a Git repository, you can set the State in linked bugs and other work items to close upon successful merging of pull requests. For more information, see Set work item state in pull request later in this article.

List and triage bugs

Most teams, whatever option they chose to track bugs, define one or more bug queries. With queries, you can list active bugs, unassigned bugs, stale bugs, bug trends, and more. You can add queries and query charts to your team dashboards to monitor bug status and progress.

Bug queries

Open a shared query or use the query editor to create useful bug queries, such as the following options:

  • Active bugs by priority (State <> Done or State <> Closed)
  • In Progress bugs (State = Committed or State = Active)
  • Bugs to fix for a target release (Tags Contains RTM)
  • Recent bugs, such as bugs opened in the last three weeks (Created Date > @Today-21)

When you have the queries of interest to your team, you can create status or trend charts. You can also add the chart you create to a dashboard.

Triage mode in query results

After you start coding and testing, hold periodic triage meetings to review and rank your bugs. Typically, the project owner runs the bug triage meetings. Team leads, business analysts, and other stakeholders who can speak about specific project risks attend the triage meetings.

The project owner can define a shared query for new and reopened bugs to list bugs to be triaged.

From the query results page, you can move up and down within the list of bug work items using the up and down arrows. As you review each bug, you can assign it, add details, or set priority.

Screenshot of Query Results, Active Bugs, and Triage mode Right pane.

Organize and assign bugs to a sprint

If your team tracks bugs as requirements, view the list of active bugs from your backlog. With the filter function, you can focus solely on bugs. From the product backlog, you can also do the following tasks:

If your team tracks bugs as tasks, use managed queries to list and triage bugs. In each sprint, you see the bugs assigned to the sprint from the Sprint backlog or Taskboard.

Taskboard items versus query list items

You might notice and wonder why the items shown on a sprint Taskboard can differ from a query list created in a corresponding sprint backlog.

It's possible to assign tasks or bugs to an iteration but not link them to a parent backlog item. These items appear in the created query, but might not show up on the Taskboard itself. The system runs the query and then applies a few background processes before displaying Taskboard items.

These reasons can cause work items that belong to the Task Category to not appear on a sprint backlog or Taskboard:

  • The task or bug isn't linked to a parent backlog item. Only bugs and tasks are linked to a parent product backlog item (Scrum), user story (Agile), or requirement (CMMI) with an iteration path set to the sprint appears on the sprint backlog page.
  • The task or bug is a parent of another task or bug, or the user story is a parent of another user story. If you create a hierarchy of tasks, bugs, or user stories, only the child-level tasks or the child-level stories at the bottom of the hierarchy appear. For more information, see Troubleshoot reordering and nesting issues.
  • The task's or bug's linked parent corresponds to a backlog item defined for another team. Or, the area path of the task's or bug's parent backlog item differs from the task's or bug's area path.

Create inline tests linked to bugs

When your team tracks bugs as requirements, you can use the board to add tests to verify bug fixes.

Screenshot of board, three columns showing inline tests added and linked to bugs.

Update bug status

You can update the bug status by dragging and dropping bugs to a new column on a board.

Customize your board to track intermediate states

You can add intermediate columns to track your bug status on the board. You can also define queries that filter based on the status of a Board Column. For more information, see the following articles:

Automate bug reassignment based on workflow state

To automate select actions, add custom rules to your Bug work item type. For example, add a rule as shown in the following image. This rule specifies to reassign a bug to the person who opened the bug when a team member resolves it. Typically, that person verifies that the bug is fixed and closes the bug. For more information, see Apply rules to workflow states (Inheritance process).

Screenshot of rule defined to reassign bug based on resolved state.

Set work item state in pull request

When you create a pull request, you can set the state value of the linked work items in the description. Follow the syntax: {state value}: #ID.

When you merge the pull request, the system reads the description and updates the work item state. The following example sets work items #300 and #301 to Resolved, and #323 and #324 to Closed.

Screenshot of setting work item state within a pull request.

Note

This feature requires installation of Azure DevOps Server 2020.1 update. For more information, see Azure DevOps Server 2020 Update 1 RC1 Release Notes, Boards.

Integration across Azure DevOps

One of the methods used by Azure DevOps to support integration is to link objects to other objects. Along with linking work items to work items, you can also link work items to other objects. Link to objects such as builds, releases, branches, commits, and pull requests as illustrated in the following image.

Diagram that shows link types used to link work items to build and release objects.

You can add a link from the work item or from the build and release objects.

The Development control supports linking to and displaying links made to builds, Git commits, and pull requests. When a TFVC repository is used, it supports links to changesets and versioned items. Choosing the link opens the corresponding item in a new browser tab. For more information, see Drive Git development from a work item.

Screenshot shows Development control on work item form with sample links to build, pull requests, and commits.

The Deployment control supports links to and display of releases that contain the work items. For example, the following image shows several releases that contain links to the current work item. You can expand each release to see details about each stage. You can choose the link for each release and stage to open the corresponding release or stage. For more information, see Link work items to deployments.

Screenshot shows Deployment control on work item form with sample releases.

Pipelines are often defined to automatically run when a new commit occurs to a Git repository. Work items associated with the commit pipelines appear as part of the pipeline run if you customize your pipeline settings. For more information, see Customize your pipeline.

Screenshot of Pipeline Settings with Automatically link work items in this run from selected branch highlighted.

Create or edit a work item upon a build failure

If you use classic pipelines (not YAML), you can create work items on a build failure. For more information, see Create a work item on failure.

You can track the bug status, assignments, and trends using queries that you can chart and add to a dashboard. For example, here are two examples showing active bug trends by State and Active Bugs by Priority over time.

Screenshot of two active bug query charts, Bug Trends by State and by Priority.

For more information about queries, charts, and dashboards see managed queries, charts, and dashboards.

Use Analytics views and the Analytics service to create bug reports

The Analytics service is the reporting platform for Azure DevOps. It replaces the previous platform based on SQL Server Reporting Services.

Analytics views provide prebuilt filters to view work items. Four Analytic views are supported for bug reporting. You can use these views as defined or further edit them to create a custom, filtered view.

  • Bugs - All history by month
  • Bugs - Last 26 weeks
  • Bugs - Last 30 days
  • Bugs - Today

For more information about using Analytic views, see About Analytics views and Create an active bugs report in Power BI based on a custom Analytics view.

You can use Power BI to create more complex reports than a query. For more information, see Connect with Power BI Data Connector.

Predefined SQL Server bug reports

The following reports are supported for Agile and CMMI processes.

These reports require that you have SQL Server Analysis Services and SQL Server Reporting Services configured for your project. To learn how to add SQL Server reports for a project, see Add reports to a project.

Marketplace extensions

There are multiple bug-related Marketplace extensions. See Marketplace for Azure DevOps.

For more information on extensions, see Azure Boards extensions developed by Microsoft.

Next steps

Use templates to add and update work items

Product backlog and board

Board

Sprint backlog and Taskboard

Integration within Azure DevOps

Industry resources