[ISSUE 98] ticket tracking #182

widal001 · 2023-07-11T14:10:11Z

Summary

Proposes ADR for ticket tracking and sprint planning

Fixes #98

Time to review: 3 mins

Changes proposed

What was added, updated, or removed in this PR.

Creates documentation/decision/adr/000n-ticket-tracking.md (Note: Will set ADR number before merging)

Context for reviewers

Testing instructions, background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers. Explain how the changes were verified.

It may be easier to view the rendered version of this ADR

Additional information

Screenshots, GIF demos, code examples or output to help show the changes working as expected.

TODO

Update 000n to a number before merging

EOKENAVA · 2023-07-11T14:55:45Z

documentation/decisions/adr/000n-ticket-tracking.md

+- **Public Requests:** Members of the public can submit bug reports and feature requests and track how that work is being prioritized
+- **Templates:** The system supports default templates for different types of tickets which prompts the person creating the ticket for a specific set of information
+- **Authority to Operate (ATO):** The platform already must be authorized under the Grants.gov ATO (Authority to Operate) or ATO coverage must be requested
+


Add "- Reporting: Users can report on key metrics like burndown, point allocation, etc. from directly within the tool
"

Good point!

lucasmbrown-usds

Overall this is very good! Seems like we just need clarity on reporting: both what exact things we need/want to report, and our plan for doing so.

Personally, I don't think we should consider this decision finalized until we have the reporting plan in place.

lucasmbrown-usds · 2023-07-11T17:11:54Z

documentation/decisions/adr/000n-ticket-tracking.md

+- **Public Requests:** Members of the public can submit bug reports and feature requests and track how that work is being prioritized
+- **Templates:** The system supports default templates for different types of tickets which prompts the person creating the ticket for a specific set of information
+- **Authority to Operate (ATO):** The platform already must be authorized under the Grants.gov ATO (Authority to Operate) or ATO coverage must be requested
+


Good point!

lucasmbrown-usds · 2023-07-11T17:21:44Z

documentation/decisions/adr/000n-ticket-tracking.md

+
+We are planning to use **GitHub issues with GitHub projects** because it is the only solution that allows members of the public to submit feature requests and bug reports and then track how those issues are being prioritized within upcoming sprints. Additionally, the use of these tools is free with public repositories and offers other helpful features such as custom fields and views.
+
+**NOTE:** Given some of the constraints around reporting, we may want to continue to explore options that extend the reporting capabilities of GitHub projects. Similarly, if team productivity is meaningfully affected by the absence of the more robust features that Jira or Zenhub offers, we may want to re-evaluate this decision after an initial trial period.


Yeah I think making a plan for reporting (as @EOKENAVA noted) would be good.

Burndown charts for the sprint and burndown charts for each milestone are probably the biggest reporting needs. But also as @EOKENAVA said, points-per-developer during sprint planning is a very very useful view, as well as average sprint velocity for the entire team, etc. Maybe we can document all of the must-have and nice-to-have reporting requirements?

One option would even be to script a reporting tool -- like I could imagine something that's not too hard to write that pulls in all GitHub milestones, checks what % of the tasks underneath those milestones is complete, generates a PDF with a burndown chart for each, and posts that burndown chart to Slack or something every day.

There are also some public tools like https://github.com/thehale/github-projects-burndown-chart or https://github.com/alessioarcara/burndown_chart.

But maybe there are some other options that already do this outside of manually creating tools. Or maybe it's just worth having a few ZenHub licenses for the internal team, and the public can view tickets in GitHub.

lucasmbrown-usds · 2023-07-11T17:22:44Z

documentation/decisions/adr/000n-ticket-tracking.md

+- ❓Unknown
+
+| Factor                    |    Zenhub     | GitHub Projects |     Jira      |  OpenProject  |
+| ------------------------- | :-----------: | :-------------: | :-----------: | :-----------: |


Nit: I think there are some IDE tools that will auto-align these markdown tables for you so that the columns are the same width through-out.

@lucasmbrown-usds I actually do use a VSCode extension that automatically adjusts table columns (Markdown table) the problem with this table is that each of the emojis has a different unicode width which is why the spacing doesn't appear uniform.

Oooh I see!

Makes reporting a must-have and outlines specific reports needed Also describes plan for producing these reports with GitHub Projects

widal001 · 2023-07-17T15:13:07Z

@lucasmbrown-usds @EOKENAVA Thanks for this feedback! Based on your suggestions, I made the following changes in this commit

Made "Reporting" a must-have decision criteria
Listed the following reports as required:
- Sprint burndown -- % of tickets and/or points remaining over the course of the sprint
- Milestone burdown -- % of tickets and/or points remaining per milestone over time
- Sprint allocation -- # of tickets and/or points allocated to each team member per sprint
- Sprint completion -- # of tickets and/or points created vs planned per sprint
- Sprint velocity -- Average # of tickets and/or points completed per sprint
- Lead/cycle time -- # of days between creation of a ticket and when that ticket is closed
Noted that our current proposed strategy for addressing this gap in functionality is to have a Python script that will generate the reports listed above

I'll plan to produce an initial proof of concept version of these reports this week. Are there any other reports we'd want to include that are not listed above?

sumiat

No further feedback, makes sense to me!

Uses a date based naming convention to prevent race conditions

lucasmbrown-usds

LGTM! Nice work on this.

widal001 added 5 commits July 10, 2023 23:43

feat(adr): Creates ticketing system ADR

9c4f03d

feat(adr): Adds comparison matrix

65efb85

refactor(adr): Rename ticketing system adr

a2b6a2b

feat(adr): Adds OpenProject to ticket tracking ADR

d0318e5

feat(adr): Adds decision outcome and links

875198c

widal001 requested review from acouch, lucasmbrown-usds, sarahknoppA6, sumiat and EOKENAVA July 11, 2023 14:10

widal001 added 2 commits July 11, 2023 10:13

feat(adr): Adds approvers to ticket tracking ADR

fab5495

Merge branch 'main' into issue-98-ticketing-system

0325d38

widal001 added docs: adr Architecture decision record ticket topic: comms Open source engagement tickets labels Jul 11, 2023

sarahknoppA6 approved these changes Jul 11, 2023

View reviewed changes

widal001 added 2 commits July 11, 2023 10:30

fix(adr): Typo in ticket tracking ADR

16b87f9

fix(adr): Typo in ticket tracking ADR

b5b0af4

EOKENAVA reviewed Jul 11, 2023

View reviewed changes

lucasmbrown-usds requested changes Jul 11, 2023

View reviewed changes

widal001 added 2 commits July 17, 2023 10:23

Merge branch 'main' into issue-98-ticketing-system

0b19baf

fix: Incorporates feedback in ticket tracking

47b580e

Makes reporting a must-have and outlines specific reports needed Also describes plan for producing these reports with GitHub Projects

widal001 requested a review from lucasmbrown-usds July 17, 2023 15:13

sumiat approved these changes Jul 17, 2023

View reviewed changes

widal001 added 3 commits July 17, 2023 15:09

Merge branch 'main' into issue-98-ticketing-system

e609b29

Merge branch 'main' into issue-98-ticketing-system

115b946

Merge branch 'main' into issue-98-ticketing-system

ca66278

widal001 added this to the Communication Platforms milestone Jul 20, 2023

widal001 added 2 commits July 21, 2023 09:13

Merge branch 'main' into issue-98-ticketing-system

e7c7484

Merge branch 'main' into issue-98-ticketing-system

2da908b

EOKENAVA self-requested a review July 25, 2023 11:44

widal001 added 2 commits July 25, 2023 11:45

refactor(adr): Renames ticket tracking ADR

6d99439

Uses a date based naming convention to prevent race conditions

Merge branch 'main' into issue-98-ticketing-system

17f0c85

lucasmbrown-usds approved these changes Jul 25, 2023

View reviewed changes

widal001 merged commit f981725 into main Jul 25, 2023

widal001 deleted the issue-98-ticketing-system branch July 25, 2023 17:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ISSUE 98] ticket tracking #182

[ISSUE 98] ticket tracking #182

widal001 commented Jul 11, 2023 •

edited

Loading

EOKENAVA Jul 11, 2023

lucasmbrown-usds Jul 11, 2023

lucasmbrown-usds left a comment

lucasmbrown-usds Jul 11, 2023

lucasmbrown-usds Jul 11, 2023

lucasmbrown-usds Jul 11, 2023

widal001 Jul 17, 2023

lucasmbrown-usds Jul 25, 2023

widal001 commented Jul 17, 2023

sumiat left a comment

lucasmbrown-usds left a comment


		We are planning to use GitHub issues with GitHub projects because it is the only solution that allows members of the public to submit feature requests and bug reports and then track how those issues are being prioritized within upcoming sprints. Additionally, the use of these tools is free with public repositories and offers other helpful features such as custom fields and views.

		NOTE: Given some of the constraints around reporting, we may want to continue to explore options that extend the reporting capabilities of GitHub projects. Similarly, if team productivity is meaningfully affected by the absence of the more robust features that Jira or Zenhub offers, we may want to re-evaluate this decision after an initial trial period.

[ISSUE 98] ticket tracking #182

[ISSUE 98] ticket tracking #182

Conversation

widal001 commented Jul 11, 2023 • edited Loading

Summary

Time to review: 3 mins

Changes proposed

Context for reviewers

Additional information

EOKENAVA Jul 11, 2023

Choose a reason for hiding this comment

lucasmbrown-usds Jul 11, 2023

Choose a reason for hiding this comment

lucasmbrown-usds left a comment

Choose a reason for hiding this comment

lucasmbrown-usds Jul 11, 2023

Choose a reason for hiding this comment

lucasmbrown-usds Jul 11, 2023

Choose a reason for hiding this comment

lucasmbrown-usds Jul 11, 2023

Choose a reason for hiding this comment

widal001 Jul 17, 2023

Choose a reason for hiding this comment

lucasmbrown-usds Jul 25, 2023

Choose a reason for hiding this comment

widal001 commented Jul 17, 2023

sumiat left a comment

Choose a reason for hiding this comment

lucasmbrown-usds left a comment

Choose a reason for hiding this comment

widal001 commented Jul 11, 2023 •

edited

Loading