Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 1 | This document explains how we handle issue triage and scheduling in [the Go project's issue tracker](http://golang.org/issue). |
| 2 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 3 | # Issue States |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 4 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 5 | Any issue must be in one of the following five states. Project contributors move issues from one state to another by doing things. The intent behind these explicit states is to describe the (minimum) next steps required to bring the issue to resolution. Issues may move between states in any order, as dictated by the needs of the particular issue. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 6 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 7 | New |
| 8 | - The issue has been filed. |
| 9 | - May not be correctly formatted (title, etc). |
| 10 | - To transition from this state, someone must clean up the issue report and optionally cc people who might best investigate or fix it. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 11 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 12 | Needs Investigation |
| 13 | - Is correctly formatted (the title has a path prefix, and the body describes the issue). |
| 14 | - Has the label `NeedsInvestigation`. |
| 15 | - May have the label `WaitingForInfo` if the investigator is waiting for more information from someone (e.g., the issue reporter). |
| 16 | - To transition from this state, someone must examine it and confirm that it is a valid issue and not a duplicate of an existing issue. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 17 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 18 | Needs Decision |
| 19 | - The issue is real, but we're not sure what action to take. Feedback is required from experts, contributors, and/or the community before a fix can be made. |
| 20 | - Note that the majority of issues will never transition to this state, as most of the time the decision is an obvious "Yes, this should be fixed." |
| 21 | - Has the label `NeedsDecision`. |
| 22 | - Has a milestone. |
| 23 | - May have the label `Blocked` if forward progress cannot be made pending the resolution of another issue or the release of a future version of Go (an accompanying comment should explain the blockage). |
| 24 | - May have the label `WaitingForInfo`. |
| 25 | - To transition from this state, someone must decide how the issue is to be resolved. |
| 26 | - If the decision is complicated, the issue may be given a `Proposal` label and the issue remains in this state until the proposal process is complete. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 27 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 28 | Needs Fix |
| 29 | - The path to resolution is known, but the work has not been done. |
| 30 | - Has the label `NeedsFix`. |
| 31 | - Has a milestone. |
| 32 | - May have the labels `Blocked` or `WaitingForInfo`. |
| 33 | - To transition from this state, someone must do the work to fix the issue. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 34 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 35 | Fixed |
| 36 | - The issue is resolved. No further attention is required. |
| 37 | - Is closed. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 38 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 39 | Issues move from one state to another where appropriate. For example, a contributor may file an issue, assign it to themselves, and immediately apply the `NeedsFix` label. Or, an issue may go from `NeedsDecision` to `NeedsFix`, only to later move back to `NeedsDecision` as complexities arise. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 40 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 41 | An issue may be closed at any time, with a comment to indicate the reason for closure ("fixed by …", "duplicate of …", "working as intended", etc). |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 42 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 43 | At any state (except New) the issue may be assigned to someone. |
| 44 | Unassigned issues are considered available for anyone to address. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 45 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 46 | # Milestones |
| 47 | Milestones describe the timeline for issue resolution. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 48 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 49 | - Go1.x.yEarly |
| 50 | |
| 51 | Must be fixed first for release 1.x.y, either because the issue is complicated and the fix needs time to bake, or because the issue is high priority. |
| 52 | |
| 53 | - Go1.x.y |
| 54 | |
| 55 | Must be fixed for release 1.x.y. |
Alberto Donizetti | e7a4a82 | 2017-02-01 22:37:32 +0100 | [diff] [blame] | 56 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 57 | - Go1.x.yMaybe |
| 58 | |
| 59 | Might be fixed for release 1.x.y. |
Alberto Donizetti | e7a4a82 | 2017-02-01 22:37:32 +0100 | [diff] [blame] | 60 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 61 | - Proposal |
| 62 | |
| 63 | Is a proposal and does not pertain to a specific release. |
Alberto Donizetti | e7a4a82 | 2017-02-01 22:37:32 +0100 | [diff] [blame] | 64 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 65 | - Soon |
| 66 | |
| 67 | Should be fixed soon, but is not included in or needed by a release. |
Alberto Donizetti | e7a4a82 | 2017-02-01 22:37:32 +0100 | [diff] [blame] | 68 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 69 | - Unplanned |
| 70 | |
| 71 | Might be fixed at some point, but nobody is planning to do it. |
Alberto Donizetti | e7a4a82 | 2017-02-01 22:37:32 +0100 | [diff] [blame] | 72 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 73 | - Unreleased |
| 74 | |
| 75 | Is not included in or needed by a release. |
Alberto Donizetti | e7a4a82 | 2017-02-01 22:37:32 +0100 | [diff] [blame] | 76 | |
| 77 | - Gccgo |
| 78 | |
| 79 | For gccgo issues. |
| 80 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 81 | - Go2 |
| 82 | |
| 83 | Deferred until Go 2. |
| 84 | |
| 85 | Additional milestones may be used to manage specific project work. |