Important: ZenHub has launched a ZenHub sprints entity separate from GitHub milestones
Changes made to GitHub milestones will not be synchronized with sprints. GitHub milestones will still exist however we recommend checking out sprints as they function similar to milestones with a few added benefits.
Burndown Charts are often associated with Scrum, a development methodology known for incremental releases and a focus on customer requirements. As an agile workflow tool, they help teams meet deadlines more predictably by providing an early indicator of how a project is coming along.
Because they provide a visualization of complete and remaining work, they're also a user-friendly reporting tool for GitHub project management.
Just like kanban boards and Epics, Burndown Charts can help you visualize projects across repositories. In ZenHub, each ZenHub sprint gets its own Burndown Chart.
Creating Burndown charts in GitHub using ZenHub
Burndown Charts are meant to track velocity during short sprints of work – and as such, they are integrated directly with your GitHub milestones or ZenHub sprints. You'll find your team's Burndown Charts in the Reports tab. To build your chart, you'll need to have a start and end date set for your GitHub milestone or ZenHub sprint. After choosing a milestone or sprint, all the issues which have been estimated will be shown.
Setting start and end dates for GitHub milestones
(Note: We now recommend checking out ZenHub sprints to automatically create and manage sprints)
To create a Burndown chart you first need to assign a start and end date for your milestone. The due date was already set when you create the milestone, but the start date of a milestone is unique to reporting in ZenHub.
Select Edit on the top right of the chart, or click Change to select dates.
Setting start and end dates for ZenHub sprints
ZenHub sprints allow you to build automatic sprint schedules that create and close by themselves. Once you set up your first sprint schedule and duration, we'll automatically create all future sprints including the start and end dates. Learn more here
With a start and end date selected, you need to ensure there are estimated Issues that are added to the sprint. If you haven't yet added estimated Issues to the sprint or estimated the issues within the sprint, you'll see an empty state. New to estimation and need best practices? Check out our blog post 'Introduction to Burndown Chart in Agile Software Development' where we cover how to estimate in ZenHub.
Adding issues to your sprint en-bulk
Head back to the Boards tab to organize the sprint. You can use the multi-action to select multiple issues to be added to the sprint, or, estimated if you forgot to estimate an issue but discussed it as a team.
The Burndown will auto-populate data points as issues are closed
The Burndown report will be split into 2 sections: sprints and milestones. Each page will function the same as the other except milestones will only show GitHub milestone data and sprints will only show ZenHub sprint data. As you finish issues assigned to the sprint, a new data point will appear, "stepping down" in the chart.
Along the middle of the graph is a light-gray, dotted line—This line represents the speed at which you need to be closing or completing issues within your sprint to complete all issues you've set out to achieve in the sprint. You can be confident you’ll achieve your goal if your team’s completed work closely aligns to this diagonal timeline.
With ZenHub sprints, Issues can be included in multiple sprints. For any issue that might not have been completed during the cycle, and carried over to the next, there will be a list of "Incomplete issues". Issues that are closed outside the Start/End times of the sprint are considered incomplete.
Viewing your sprint plan or sprint report
When viewing the Burndown report, you can scroll beneath the graph to view your sprint plan ( when the sprint is current) or your sprint report ( when the sprint is closed).
You will see a list of all the issues ( both estimated and unestimated) that have been added to your sprint. These issues will be divided into three separate sections:
1. Remaining issues and PRs: This will display all open issues and PRs that have not yet been closed for the current sprint
2. Completed issues and PRs: This will display all issues that have been closed for the current sprint
3. Incomplete issues and PRs that were not completed by the end of the sprint: This will display all issues (both open and closed) that were not closed during the sprint cycle (i.e these issues were closed outside the start and end dates set for the Sprint)
The completion statistics for the Burndown report will remain static after the sprint/milestone has been closed. Therefore, if issues are closed after the sprint has ended, the report will still reflect the number of issues/ story points that were completed on the end date set for that sprint:
Defining what is "done" using burn pipelines
By default, Burndown Charts display closed issues and PRs as data points. You can also customize which pipeline triggers a “burned” task by using the Burn Pipelines dropdown menu. For example, if your development team considers a task complete when it reaches the “Ready for QA” pipeline, they can set that here for a more accurate picture of their priorities and progress.
Filtering the Burndown: What sprints appear
Currently, the ZenHub Burndown report will be available for the last 10 closed sprints or milestones. If a milestone or sprint is too old, you won't be able to pull up the previous Burndown. If you need to save this information, we request using the print-page functionality of your Browser, or leveraging our 'Export to CSV' option for further analysis and customization
Export your Burndown report
When viewing a Burndown report, you can export the report to CSV to further customize and analyse data. To export your report, navigate to to your Burndown report where there is an Export to CSV option located in the top right of the Report page next to the Report title. The fields included in the export are:
- Total story points
- Completed story points
- Ideal speed at which you should be closing issues
- Issues completed