...
To encourage high quality data entry and better observability, we propose a few changes to the project Workflow.
New 'Triage' State
Currently it is easy for the project to miss a ticket, and for that ticket to fall through the cracks indefinitely.
At the same time, user reports cannot be expected to fill out all of the required fields accurately.
It's proposed that we introduce a new initial state named 'Triage' that has no required fields, and that anybody may file.
To transition to the Open state, you must be a contributor in JIRA (equivalent to able to assign tickets), and must ensure the required fields have been correctly filled out before doing so.
Removal of Reopened State
New 'Review in Progress' and 'Change Requested' States
Presently there is no way to indicate that a patch is under active review, so it is hard for assignees to monitor the progress of their patch to completion. Similarly, there is no useful way for the reviewer to indicate that their comments are ready to be addressed by the assignee. With the introduction of these two states, there is a clear handover at each stage of the process. This makes it clear who is responsible for taking the patch forward to the next step, as well as transparency over progress on any steps you are waiting on.
Removal of Reopened State
The Reopened state is of dubious value - arguably, it is in any scenario more helpful to file a new ticket, link the The Reopened state is of dubious value - arguably, it is in any scenario more helpful to file a new ticket, link the two via a relation, and leave a comment on the original for interested parties to migrate to the new discussion. In any case, its use is frowned upon and rare. It will of course remain possible to move a ticket from the 'Resolved' state to e.g. the Open state, but this will not be officially sanctioned except when correcting filing/procedural errors.
New Workflow
...
State | Description | Expected Transitions (To) |
---|---|---|
Triage | This ticket has been filed, perhaps by a member of the community, but has not been considered by a contributor competent to assess its impact, severity, etc. Before transitioning to Open, the contributor should consider updating the title and summary to best reflect the report in a way the project will understand. | Awaiting Feedback, Open, Resolved |
Awaiting Feedback | Most beneficial as a cyclical state between Triage and itself, as dialogue takes place to establish any facts needed to understand, categorise and prioritise the report. | Triage, Open, Resolved |
Open | The ticket is prioritised and well summarised, but work is not yet underway. | In Progress |
In Progress | The assignee is 'actively' working on this ticket | Patch Available, Open |
Patch Available | The assignee has a patch that is ready for a reviewer. The assignee should endeavour to solicit from the community a reviewer competent in the subsystem(s) from, if none is already assigned. | Review in Progress |
Review in Progress | The assigned reviewer is 'actively' reviewing the available patch | Change Requested, Ready to Commit |
Change Requested | The reviewer has provided feedback for the assignee to consider and incorporate into their patch. Once they are ready to address these points, they should transition the ticket back to 'In Progress' | In Progress |
Ready to Commit | The reviewer(s) consider this patch to be ready to commit | Resolved |
Resolved | The ticket has been closed (either successfully or unsuccessfully) |
...