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 | |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 5 | Any issue must be in one of the following states. Project contributors move issues from one state to another. 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 | |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 7 | ### New |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 8 | - The issue has been filed. |
| 9 | - May not be correctly formatted (title, etc). |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 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 | |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 12 | ### Needs Investigation |
| 13 | - Is correctly formatted. |
| 14 | - The title has a path prefix. |
| 15 | - The body describes the issue. |
| 16 | - Has a milestone. |
Agniva De Sarker | ed886a3 | 2018-05-25 11:30:07 +0530 | [diff] [blame] | 17 | - If the issue is not important, it is ok to set the milestone to unplanned. Otherwise, set it to the next upcoming release. |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 18 | - Has the label `NeedsInvestigation`. |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 19 | - May also have the label `WaitingForInfo` if the investigator is waiting for more information from someone (e.g., the issue reporter). |
| 20 | - To transition from this state, someone must examine the issue and confirm that it is valid and not a duplicate of an existing issue. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 21 | |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 22 | ### Needs Decision |
| 23 | - The issue is real, but we're not sure what action to take. |
| 24 | - The issue can be addressed in Go 1. |
| 25 | - Feedback is required from experts, contributors, and/or the community before a fix can be made. |
| 26 | - 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.” |
| 27 | - Has a milestone. |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 28 | - Has the label `NeedsDecision`. |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 29 | - May have the label `WaitingForInfo`. |
| 30 | - May have the label `Blocked` if forward progress depends upon the resolution of another issue or the release of a future version of Go. An accompanying comment should explain the blockage. |
| 31 | - Must not have the label `Go2`. (Those issues are handled separately.) |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 32 | - To transition from this state, someone must decide how the issue is to be resolved. |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 33 | - If the decision is complicated, the issue may be given a [`Proposal`](https://github.com/golang/proposal/) label. The issue remains in this state until the proposal process is complete, and moves to `NeedsFix` if approved. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 34 | |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 35 | ### Needs Fix |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 36 | - The path to resolution is known, but the work has not been done. |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 37 | - Has a milestone. |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 38 | - Has the label `NeedsFix`. |
| 39 | - May have the labels `Blocked` or `WaitingForInfo`. |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 40 | - 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] | 41 | |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 42 | ### Fixed |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 43 | - The issue is resolved. No further attention is required. |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 44 | - The issue is closed. |
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 | 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] | 47 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 48 | 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] | 49 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 50 | At any state (except New) the issue may be assigned to someone. |
| 51 | Unassigned issues are considered available for anyone to address. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 52 | |
Filippo Valsorda | dace144 | 2018-04-11 18:20:10 -0400 | [diff] [blame] | 53 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 54 | # Milestones |
Bryan C. Mills | 008880a | 2018-04-11 18:46:52 -0400 | [diff] [blame] | 55 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 56 | Milestones describe the timeline for issue resolution. |
Andrew Gerrand | 5bc444d | 2014-12-10 11:35:11 +1100 | [diff] [blame] | 57 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 58 | - Go1.x.y |
| 59 | |
Ian Lance Taylor | 7e3d339 | 2017-11-09 14:56:58 -0800 | [diff] [blame] | 60 | Must be fixed for release 1.x.y, or explicitly postponed to a later release. |
Alberto Donizetti | e7a4a82 | 2017-02-01 22:37:32 +0100 | [diff] [blame] | 61 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 62 | - Proposal |
| 63 | |
| 64 | Is a proposal and does not pertain to a specific release. |
Alberto Donizetti | e7a4a82 | 2017-02-01 22:37:32 +0100 | [diff] [blame] | 65 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 66 | - Soon |
| 67 | |
| 68 | 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] | 69 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 70 | - Unplanned |
| 71 | |
| 72 | 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] | 73 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 74 | - Unreleased |
| 75 | |
| 76 | Is not included in or needed by a release. |
Alberto Donizetti | e7a4a82 | 2017-02-01 22:37:32 +0100 | [diff] [blame] | 77 | |
| 78 | - Gccgo |
| 79 | |
| 80 | For gccgo issues. |
| 81 | |
Quentin Smith | 4406933 | 2016-10-03 14:50:35 -0400 | [diff] [blame] | 82 | - Go2 |
| 83 | |
| 84 | Deferred until Go 2. |
| 85 | |
| 86 | Additional milestones may be used to manage specific project work. |