Skip to content

Commit 6aec48f

Browse files
committed
Stronger opinion on existing labels
Signed-off-by: Jan Fajerski <[email protected]>
1 parent 2d09fee commit 6aec48f

File tree

1 file changed

+38
-17
lines changed

1 file changed

+38
-17
lines changed

proposals/0065-issue-pr-label-system.md

Lines changed: 38 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,13 @@ These labels indicate whether an issue has been evaluated and is ready for work:
8282
- **`triage/accepted`**: Issue has been triaged and accepted as valid work. It is ready for someone to work on.
8383
- **`triage/needs-information`**: Issue needs more details from the author before it can be properly evaluated or worked on.
8484

85-
**Workflow**: All issues start with `triage/needs-triage`. During triage, maintainers either replace this with another triage label or remove it entirely. The absence of any triage label (along with issue comments) indicates that triage action has been taken and the issue is currently being worked on. Declined or duplicate issues should also have no `triage/` label.
85+
**Workflow**: All issues start with `triage/needs-triage`. During triage,
86+
maintainers either replace this with another triage label or remove it entirely.
87+
88+
Instead a `kind/` label should be added. The absence of any triage label (along
89+
with issue comments) indicates that triage action has been taken and the issue
90+
is currently being worked on. Declined or duplicate issues should also have no
91+
`triage/` label.
8692

8793
#### 2. Review Labels
8894

@@ -126,8 +132,8 @@ Labels from different categories work together:
126132

127133
This section documents the existing label taxonomies currently in use across
128134
Prometheus repositories, particularly in prometheus/prometheus. These labels are
129-
included here for documentation purposes and reflect current practice. The
130-
proposal above aims to replace some of the currently in use labels.
135+
included here for documentation purposes, to reflect current practice and to propose
136+
how to handle these labels going forward.
131137

132138
#### Component and area Labels
133139

@@ -153,6 +159,10 @@ indicate the affected areas. Multiple component labels may be applied if changes
153159
span multiple components. Area labels are less commonly used than component
154160
labels and typically indicate cross-cutting concerns or specific initiatives.
155161

162+
**Proposal**: Keep the `component/` and `area/` prefixes and leave the suffixes
163+
unspecified so that developers can add them as needed. Move any current labels
164+
to use the prefixes where needed.
165+
156166
#### Kind Labels
157167

158168
Kind labels categorize the type of change or issue:
@@ -167,6 +177,9 @@ Kind labels categorize the type of change or issue:
167177

168178
**Usage**: Issues and PRs typically have exactly one kind label to indicate the primary nature of the change. The kind label helps communicate the impact and urgency of the change.
169179

180+
**Proposal**: Keep the labels and recommend to add them manually to issues after
181+
triage and to PRs as needed.
182+
170183
#### Priority Labels
171184

172185
Priority labels indicate the urgency and importance of an issue or PR:
@@ -179,31 +192,39 @@ Priority labels indicate the urgency and importance of an issue or PR:
179192

180193
**Usage**: Priority labels are typically assigned during triage and help maintainers and contributors understand what to work on first. Not all issues have priority labels assigned.
181194

182-
#### Other Common Labels
183-
184-
Many other labels are currently in use. this proposal does not seek to prescribe
185-
any changes to how all labels are used. For example to following are well
186-
established and usefule:
187-
188-
- **`help wanted`**: Good issues for external contributors
189-
- **`good first issue`**: Good for newcomers to the project
190-
- **`low hanging fruit`**: Easy to implement
191-
- **`not-as-easy-as-it-looks`**: Appears simple but has hidden complexity
195+
**Proposal**: Keep the labels and recommend to use as needed.
192196

193-
Other labels should probably be unified into the label taxonomy proposed above.
197+
#### Other Common Labels
194198

195-
For example:
199+
Many other labels are currently in use. Many overlap with the taxonomy proposed
200+
here, for example:
196201

197202
- **`duplicate`**: Duplicate of another issue
198203
- **`invalid`**: Issue is not valid or is spam
199204
- **`won't fix`**: Issue will not be addressed
200205
- **`stale`**: No recent activity
201206
- **`keepalive`**: Should not be marked stale or auto-closed
202207

208+
Some currently used labels are well established and seem useful but don't fit
209+
well into the proposed taxonomy:
210+
211+
- **`help wanted`**: Good issues for external contributors, might require specific expertise
212+
- **`good first issue`**: Good for newcomers to the project
213+
- **`not-as-easy-as-it-looks`**: Appears simple but has hidden complexity
214+
- `dependencies`: Used by dependeabot
215+
216+
A few labels have served a temporary purpose:
217+
218+
- `hacktoberfest`
219+
- `backport-*`: Track backports for LTS releases
220+
203221
**Usage**: These labels serve various workflow and community needs. Some are
204222
applied manually, while others (like `dependencies`) are often applied
205-
automatically. Some labels should be abandoned in favor of the structured labels
206-
proposed above.
223+
automatically.
224+
225+
**Proposal**: Most labels should be abandoned in favor of the structured labels
226+
proposed above. Keep a few regular exceptions and the option for temporary
227+
labels for a specific purpose.
207228

208229
### Implementation Considerations
209230

0 commit comments

Comments
 (0)