Skip to content

Commit f9316b9

Browse files
authored
Updates to our triage guidelines (#4180)
* Updates to our triage guidelines A few things I've wanted as I do PM, plus some changes for later automation via probot: * Drop `Enhancement` -- it vaguely implies "new feature" * Instead use `Feature` for new **accepted** and on our roadmap features * If an issue doesn't describe a bug, and is not a new feature, it's likely an Improvement. The distinction here is `Feature` is a new feature, `Bug` has higher priority than `Improvement` * `Needed: more information` is a way to track issues that require a reply and can be closed if we don't get that reply. Currently, we use this in some places as a way to describe issues that we need to collect more ideas on -- a good substitute is `Needed: design decision` * Also add `Status: stale` for issue automation * Drop unused statuses for closed issues * Drop PR: ready as this is a leftover from before GH had reviews * Drop `Feaure Overview`, this is synonymous with `Feature` The takeaway here for purposes of what to audit with these changes in place: * If an issue is an `Enhancement` now: * It becomes a `Feature` if it is a new feature and belongs on our roadmap * It becomes an `Improvement` if it is not a bug and belongs on our roadmap * It gets closed otherwise, it's not important to us * Issues that are `Needed: more information` can be closed if there was no reply after 7 days. We might need to retriage some issues where this label was applied for another reason Also, suggestions for alternatives to `Improvement` are helpful, if this isn't descriptive enough. * 7d -> 2w, drop Community Effort, add Accepted label * Also make Priority: high and Priority: low Priority: high already exists in rtfd/readthedocs.org. Matching low priority for extra use as well. * Add PR hotfix
1 parent 3a47d63 commit f9316b9

File tree

1 file changed

+52
-47
lines changed

1 file changed

+52
-47
lines changed

docs/issue-labels.rst

Lines changed: 52 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -6,94 +6,99 @@ what they stand for.
66

77
.. _GitHub issue tracker: https://github.com/rtfd/readthedocs.org/issues
88

9-
*Bug*
10-
An issue describing unexpected or malicious behaviour of the
11-
readthedocs.org software.
9+
*Accepted*
10+
Issues with this label are issues that the core team has accepted on to the
11+
roadmap. The core team focuses on accepted bugs, features, and improvements
12+
that are on our immediate roadmap and will give priority to these issues.
13+
Pull requests could be delayed or closed if the pull request doesn't align
14+
with our current roadmap. An issue or pull request that has not been
15+
accepted should either eventually move to an accepted state, or should be
16+
closed. As an issue is accepted, we will find room for it on our roadmap,
17+
either on an upcoming release (point release milestones), or on a future
18+
milestone project (named milestones).
1219

13-
*Community Effort*
14-
Tickets with this label are valid issues that the core team thinks are
15-
worth to fix or implement in the future. However the core team's resources
16-
are too scarce to address these issues. Tickets marked with this label
17-
are issues that the core team will **not** work on, but contributions
18-
from the community are very welcome.
20+
*Bug*
21+
An issue describing unexpected or malicious behaviour of the readthedocs.org
22+
software. A Bug issue differs from an Improvement issue in that Bug issues
23+
are given priority on our roadmap. On release, these issues generally only
24+
warrant incrementing the patch level version.
1925

2026
*Design*
2127
Issues related to the UI of the readthedocs.org website.
2228

23-
*Enhancement*
24-
Feature requests and ideas about how to make readthedocs.org better in
25-
general will have this label.
26-
27-
*Feature Overview*
28-
Features that are too big to be tackled in one ticket are split up into
29-
multiple tickets. A feature overview ticket is then explaining the overarching
30-
idea. See the milestone of the feature overview ticket for all related
31-
tickets.
29+
*Feature*
30+
Issues that describe new features. Issues that do not describe new features,
31+
such as code cleanup or fixes that are not related to a bug, should probably
32+
be given the Improvement label instead. On release, issues with the Feature
33+
label warrant at least a minor version increase.
3234

3335
*Good First Issue*
34-
This label marks tickets that are easy to get started with. The ticket
36+
This label marks issues that are easy to get started with. The issue
3537
should be ideal for beginners to dive into the code base.
3638

37-
*High Priority*
38-
Tickets with this label should be resolved as quickly as possible.
39+
*Priority: high*
40+
Issues with this label should be resolved as quickly as possible.
41+
42+
*Priority: low*
43+
Issues with this label won't have the immediate focus of the core team.
3944

40-
*Mkdocs*
41-
Tickets that are related to the Mkdocs builder.
45+
*Improvement*
46+
An issue with this label is not a Bug nor a Feature. Code cleanup or small
47+
changes to existing features would likely have this label. The distinction
48+
for this label is that these issues have a lower priority on our roadmap
49+
compared to issues labeled Bug, and aren't implementing new features, such
50+
as a Feature issue might.
4251

4352
*Needed: design decision*
44-
Tickets that need a design decision are blocked for development until a
53+
Issues that need a design decision are blocked for development until a
4554
project leader clarifies the way in which the issue should be approached.
4655

4756
*Needed: documentation*
4857
If an issue involves creating or refining documentation, this label will be
4958
assigned.
5059

5160
*Needed: more information*
52-
This label indicates that the issue has not enough information in order to
53-
decide on how to go forward. See the documentation about our :ref:`triage
54-
process <triage-not-enough-information>` for more information.
61+
This label indicates that a reply with more information is required from the
62+
bug reporter. If no response is given by the reporter, the issue is
63+
considered invalid after 2 weeks and will be closed. See the documentation
64+
about our :ref:`triage process <triage-not-enough-information>` for more
65+
information.
5566

5667
*Needed: patch*
5768
This label indicates that a patch is required in order to resolve the
58-
ticket. A fix should be proposed via a pull request on GitHub.
69+
issue. A fix should be proposed via a pull request on GitHub.
5970

6071
*Needed: tests*
6172
This label indicates that a better test coverage is required to resolve
62-
the ticket. New tests should be proposed via a pull request on GitHub.
73+
the issue. New tests should be proposed via a pull request on GitHub.
6374

6475
*Needed: replication*
6576
This label indicates that a bug has been reported, but has not been
6677
successfully replicated by another user or contributor yet.
6778

6879
*Operations*
69-
Tickets that require changes in the server infrastructure.
70-
71-
*PR: ready for review*
72-
Pull Requests that are considered complete. A review by at least one core
73-
developer is required prior to merging it.
80+
Issues that require changes in the server infrastructure.
7481

7582
*PR: work in progress*
7683
Pull Requests that are not complete yet. A final review is not possible
7784
yet, but every Pull Request is open for discussion.
7885

86+
*PR: hotfix*
87+
Pull request was applied directly to production after a release. These pull
88+
requests still need review to be merged into the next release.
89+
7990
*Sprintable*
80-
Sprintable are all tickets that have the right amount of scope to be
91+
Sprintable are all issues that have the right amount of scope to be
8192
handled during a sprint. They are very focused and encapsulated.
8293

8394
*Status: blocked*
84-
The ticket cannot be resolved until some other ticket has been closed.
85-
See the ticket's log for which ticket is blocking this ticket.
86-
87-
*Status: duplicate*
88-
See the ticket's log to find the original ticket that this one is a
89-
duplicate of.
90-
91-
*Status: invalid*
92-
A ticket is invalid if the reported issue cannot be reproduced.
95+
The issue cannot be resolved until some other issue has been closed.
96+
See the issue's log for which issue is blocking this issue.
9397

94-
*Status: rejected*
95-
A ticket gets rejected if the proposed enhancement is not in line with the
96-
overall goals of readthedocs.org.
98+
*Status: stale*
99+
A issue is stale if it there has been no activity on it for 90 days. Once a
100+
issue is determined to be stale, it will be closed after 2 weeks unless
101+
there is activity on the issue.
97102

98103
*Support*
99104
Questions that needs answering but do not require code changes or issues

0 commit comments

Comments
 (0)