Issue 1018 sprint burnup metric #1371
Conversation
AlexanderStephensonUSDS
requested review from
sumiat,
andycochran,
acouch,
SammySteiner,
aplybeah and
chouinar
as code owners
github-actions
bot
added
documentation
|
PR still needs to include test coverage. Wanted to put this up for code discussion. |
documentation/analytics/usage.md
Outdated
| @@ -120,6 +120,11 @@ Once you've exported the sprint and issue data from GitHub, you can start calcul | |||
| poetry run analytics calculate sprint_burndown --sprint-file data/sprint-data.json --issue-file data/issue-data.json --sprint @current --unit points --show-results | |||
| ``` | |||
|
|
|||
| If on a Windows machine: | |||
There was a problem hiding this comment.
Instead of specifying a different command for windows, might be worth just tweaking the guidance below to wrap @current in quotes since it also works with quotes on Mac/Linux
There was a problem hiding this comment.
Good call. Done.
There was a problem hiding this comment.
Looks good! I confirmed that we get the same output for sprint burndown as before and the sprint burnup looks right to me as well!
There is something strange happening with the default zoom (see screenshot) but we can tackle that in a followup ticket
Default zoom
Zoomed out
| @@ -89,6 +90,30 @@ def calculate_sprint_burndown( | |||
| post_results=post_results, | |||
| ) | |||
|
|
|||
| @metrics_app.command(name="sprint_burnup") | |||
There was a problem hiding this comment.
Thanks for adding this CLI utility, made it really easy to check!
| template="none", | ||
| ) | ||
| # set the scale of the y axis to start at 0 | ||
| chart.update_yaxes(range=[0, df["value"].max() + 10]) |
There was a problem hiding this comment.
I wonder if this is impacting the zoom since we're using a stacked bar chart
Summary
Fixes #1018
Time to review: 5 mins
Changes proposed
The PR adds a Sprint Burnup metric to the analytics package.
In addition, it updates the documentation to include the description and calculation of the Burnup metric.
Context for reviewers
Additional information