You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/adr/20251211-github-issue-management-agreement.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,14 @@
12
12
- Simplify contributor task tracking (especially for ad-hoc contributors)
13
13
- Simplify onboarding/rebuilding context on projects as contributors hop around from project to project
14
14
- Simplify scanning issues in the Issues view (or any aggregated view) to identify what is relevant to project
15
+
- Have defined owners of work
15
16
- 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)
17
18
18
19
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.
19
20
21
+
**Project is used to mean a body of work. Clarifying as project is a reserved github word that can mean something else.
22
+
20
23
### Is this broadly desired?
21
24
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.
22
25
@@ -42,9 +45,12 @@ The epic/objective issue should have
42
45
- the expected stakeholders of the work
43
46
- if there's an ongoing meeting, when it happens (so users can easily find the invite, gemini notes, and recordings)
44
47
- 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)
47
49
<imgwidth="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)
48
54
- all related milestones (if relevant) where milestone fields have
49
55
- title
50
56
- description / scope of work
@@ -85,9 +91,6 @@ All issues (epics, sub-issues, bugs) should live in their relevant corresponding
85
91
- 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.
86
92
- TBD agreement on PR requirements and turnaround time
87
93
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
-
91
94
## Helpful Github links on using Issues to manage projects including views to track progress
0 commit comments