Skip to content

Commit 02b8e2f

Browse files
committed
adding edits to identify TBD items and include items from PI issue template
1 parent b4db757 commit 02b8e2f

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/adr/20251211-github-issue-management-agreement.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,14 @@
1212
- Simplify contributor task tracking (especially for ad-hoc contributors)
1313
- Simplify onboarding/rebuilding context on projects as contributors hop around from project to project
1414
- Simplify scanning issues in the Issues view (or any aggregated view) to identify what is relevant to project
15+
- Have defined owners of work
1516
- Prevent orphan tickets / orphaned work / missed issues
16-
- Help folks better understand how an issue should be defined. (Creating guidelines could help folks better understand how to breakdown a body of work)
17+
- Help folks better understand how an issue should be defined. Creating guidelines could help folks better understand how to breakdown a body of work. (TBD - who own issue generation at different stages of a project)
1718

1819
These needs can be accomplished by agreeing to a structure of organizing information, using issue templates and just trying it out to see how it goes knowing it won't be perfect. Hopefully this can be a stepping stone to defining some project processes to facilitate better team alignment on work.
1920

21+
**Project is used to mean a body of work. Clarifying as project is a reserved github word that can mean something else.
22+
2023
### Is this broadly desired?
2124
Currently I've seen different individuals put effort into implementing and suggesting (Thank you @vitor) systems for managing github issues and a strong desire to have all project work logged. That leads me to believe we need it, and there's appetite to align on one! So hopefully the buy-in is there.
2225

@@ -42,9 +45,12 @@ The epic/objective issue should have
4245
- the expected stakeholders of the work
4346
- if there's an ongoing meeting, when it happens (so users can easily find the invite, gemini notes, and recordings)
4447
- an issue type of epic (with owner org access it would be easy [to add 'epic' as a ticket type](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization))
45-
- an estimated start date and estimated delivery date
46-
- scope of work / what we have agreed to do and not to do (TBD - when this shows up in our project workflow, but it must be included)
48+
- an estimated start date and estimated delivery date (these could be as rough as quarters / PIs)
4749
<img width="1269" height="471" alt="Screenshot 2025-12-11 at 12 22 02 PM" src="https://github.com/user-attachments/assets/2accce9b-d2da-4b35-87f4-9bfc1872ba56" />
50+
51+
- risks
52+
- scope of work / what we have agreed to do and not to do
53+
(TBD - when this shows up in our project workflow, but it must be defined)
4854
- all related milestones (if relevant) where milestone fields have
4955
- title
5056
- description / scope of work
@@ -85,9 +91,6 @@ All issues (epics, sub-issues, bugs) should live in their relevant corresponding
8591
- Should be linked to an issue. You can use [GH keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) like 'closes' or the `#` to bring up issue numbers to link without automations.
8692
- TBD agreement on PR requirements and turnaround time
8793

88-
89-
**Project is used to mean a body of work. Clarifying as project is a reserved github word that can mean something else.
90-
9194
## Helpful Github links on using Issues to manage projects including views to track progress
9295
* https://docs.github.com/en/issues
9396
* https://docs.github.com/en/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view

0 commit comments

Comments
 (0)