Skip to content

Commit 3619744

Browse files
committed
add πŸ“– aspect: docs, remove πŸŽƒ Hacktoberfest, and order entries
1 parent d71905e commit 3619744

File tree

1 file changed

+52
-42
lines changed

1 file changed

+52
-42
lines changed

β€Žcontent/contributing-code/repo-labels/contents.lr

+52-42
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,16 @@ _template: page-with-toc.html
44
---
55
title: Repository Labels
66
---
7-
description: To facilitate the community in finding ways to contribute that match their experiences and skillsets, we have developed a comprehensive system for labelling issues and PRs. This is an introduction to this standard labelling scheme.
7+
description: To facilitate the community in finding ways to contribute that
8+
match their experiences and skillsets, we have developed a comprehensive system
9+
for labelling issues and PRs. This is an introduction to this standard
10+
labelling scheme.
811
---
912
body:
1013

11-
Labels consist of three fields, viz. name, description and color. Label names
12-
should have a consistent format to aid both filtering within the github UI as
13-
well as scanning visually through the list. The following format is the most
14+
Labels consist of three fields, viz. name, description and color. Label names
15+
should have a consistent format to aid both filtering within the github UI as
16+
well as scanning visually through the list. The following format is the most
1417
suited to this task (where `⎡` denotes a single space):
1518

1619
```
@@ -31,6 +34,7 @@ An issue has many different attributes:
3134
- Talk
3235
- Friendliness
3336

37+
3438
### *Priority
3539

3640
<div class="table-container">
@@ -59,8 +63,8 @@ An issue has many different attributes:
5963
</table>
6064
</div>
6165

62-
The priority of an issue is based on its impact, derived from a combination of
63-
urgency and importance. This determines the importance of the issue when sprint
66+
The priority of an issue is based on its impact, derived from a combination of
67+
urgency and importance. This determines the importance of the issue when sprint
6468
planning or deciding which issues to tackle next.
6569

6670
- <span class="gh-label priority-unfavourable">
@@ -80,6 +84,7 @@ planning or deciding which issues to tackle next.
8084
</span>
8185
- **Description:** Low priority and doesn't need to be rushed
8286

87+
8388
### *Status
8489

8590
<div class="table-container">
@@ -112,32 +117,24 @@ The status of the issue determines whether it is ready for work or not. Issues
112117
may not be ready to be worked on for a number of reasons and the maintainers
113118
must keep updating the labels as the situation evolves.
114119

115-
An issue, at the time of closing can have either the
120+
An issue, at the time of closing can have either the
116121
<span class="gh-label status-light">
117122
🏁 status: ready for dev
118123
</span>
119-
or the
124+
or the
120125
<span class="gh-label status-lighter">
121126
⛔️ status: discarded
122127
</span>
123128
label based on whether it was closed with or without resolution, respectively.
124129

125-
- <span class="gh-label status-light">
126-
🏁 status: ready for dev
130+
- <span class="gh-label status-darker">
131+
🚦 status: awaiting triage
127132
</span>
128-
- **Description:** Ready for work
133+
- **Description:** Has not been triaged & therefore, not ready for work
129134
- <span class="gh-label status-neutral">
130135
🚧 status: blocked
131136
</span>
132137
- **Description:** Blocked & therefore, not ready for work
133-
- <span class="gh-label status-dark">
134-
🧹 status: ticket work required
135-
</span>
136-
- **Description:** Needs more details before it can be worked on
137-
- <span class="gh-label status-dark">
138-
🏷 status: label work required
139-
</span>
140-
- **Description:** Needs proper labelling before it can be worked on
141138
- <span class="gh-label status-lighter">
142139
⛔️ status: discarded
143140
</span>
@@ -146,10 +143,19 @@ label based on whether it was closed with or without resolution, respectively.
146143
πŸ™… status: discontinued
147144
</span>
148145
- **Description:** Not suitable for work as repo is in maintenance
149-
- <span class="gh-label status-darker">
150-
🚦 status: awaiting triage
146+
- <span class="gh-label status-dark">
147+
🏷 status: label work required
151148
</span>
152-
- **Description:** Has not been triaged & therefore, not ready for work
149+
- **Description:** Needs proper labelling before it can be worked on
150+
- <span class="gh-label status-light">
151+
🏁 status: ready for dev
152+
</span>
153+
- **Description:** Ready for work
154+
- <span class="gh-label status-dark">
155+
🧹 status: ticket work required
156+
</span>
157+
- **Description:** Needs more details before it can be worked on
158+
153159

154160
### *Goal
155161

@@ -158,54 +164,60 @@ represents the impact of the issue on the scope of the software.
158164

159165
- <span class="gh-label goal">⭐ goal: addition</span>
160166
- **Description:** Addition of new feature
161-
- <span class="gh-label goal">✨ goal: improvement</span>
162-
- **Description:** Improvement to an existing feature
163167
- <span class="gh-label goal">πŸ›  goal: fix</span>
164168
- **Description:** Bug fix
169+
- <span class="gh-label goal">✨ goal: improvement</span>
170+
- **Description:** Improvement to an existing feature
171+
165172

166173
### *Aspect
167174

168175
The aspect of an issue is the side of the project that the issue deals with. A
169176
single codebase can have multiple aspects to it and knowing which ones will be
170177
touched helps contributors find relevant issues.
171178

172-
- <span class="gh-label aspect">πŸ“„ aspect: text</span>
173-
- **Description:** Concerns the textual material in the repository
174179
- <span class="gh-label aspect">πŸ’» aspect: code</span>
175180
- **Description:** Concerns the software code in the repository
176-
- <span class="gh-label aspect">πŸ•Ή aspect: interface</span>
177-
- **Description:** Concerns end-users' experience with the software
181+
- <span class="gh-label aspect">πŸ“– aspect: docs</span>
182+
- **Description:** Concerns the documentation in the repository
178183
- <span class="gh-label aspect">πŸ€– aspect: dx</span>
179184
- **Description:** Concerns developers' experience with the codebase
185+
- <span class="gh-label aspect">πŸ•Ή aspect: interface</span>
186+
- **Description:** Concerns end-users' experience with the software
187+
- <span class="gh-label aspect">πŸ“„ aspect: text</span>
188+
- **Description:** Concerns the textual material in the repository
189+
180190

181191
### Skill
182192

183-
The technical skills a person is required to possess to work on the issue.
193+
The technical skills a person is required to possess to work on the issue.
184194
Skills are a special type of label that vary by repository. Issues may not have
185195
a skill tag if no special skills are required.
186196

187197
- <span class="gh-label skill">πŸ’ͺ skill: &lt;skill name&gt;</span>
188198
- **Description:** Requires proficiency in '&lt;skill name&gt;'
189199

200+
190201
### Talk
191202

192203
Issues with interaction labels do not entail any work to be done on the
193-
repository. They are for Q&A, RFCs and any other form of discussions. While both
194-
of these may appear to be too similar, triage permissions are granted to
204+
repository. They are for Q&A, RFCs and any other form of discussions. While
205+
both of these may appear to be too similar, triage permissions are granted to
195206
collaborators who might not have the answers to questions but by labelling them
196207
as such, they might draw a faster response from an experienced contributor who
197-
does. _In the future this category might be rendered redundant by GitHub
208+
does. _In the future this category might be rendered redundant by GitHub
198209
Discussions and will be removed._
199210

200-
- <span class="gh-label talk">❓ talk: question</span>
201-
- **Description:** Can be resolved with an answer
202211
- <span class="gh-label talk">πŸ’¬ talk: discussion</span>
203212
- **Description:** Open for discussions and feedback
213+
- <span class="gh-label talk">❓ talk: question</span>
214+
- **Description:** Can be resolved with an answer
215+
204216

205217
### Friendliness
206218

207-
The level of friendliness a particular issue is the valency of the issue
208-
towards contributions from the community. Some issues provide a great
219+
The level of friendliness a particular issue is the valency of the issue
220+
towards contributions from the community. Some issues provide a great
209221
introduction while others require a little more familiarity with the codebase.
210222
_These issues do not have the category prefix as two of them are special labels
211223
recognized by GitHub. The special ones don't have emojis either._
@@ -217,33 +229,31 @@ recognized by GitHub. The special ones don't have emojis either._
217229
- <span class="gh-label friendliness">πŸ”’ staff only</span>
218230
- **Description:** Restricted to CC staff members
219231

232+
220233
### Miscellaneous
221234

222235
- <span class="gh-label miscellaneous">
223236
🀯 γƒŽΰ² η›Šΰ² γƒŽε½‘β”»β”β”»
224237
</span>
225238
- **Description:** Aaargh!
226-
- <span class="gh-label hacktoberfest">
227-
Hacktoberfest
228-
</span>
229-
- **Description:** Good issues for Hacktoberfest participants
230239
- <span class="gh-label invalid">
231240
invalid
232241
</span>
233242
- **Description:** Inappropriate or invalid (ex. Hacktoberfest spam)
234243

244+
235245
## Usage rules
236246

237247
In the above categories, some are marked with an `*` sign. Those are mandatory
238248
categories and every issue is required to have at least one label from those
239249
categories.
240250

241-
Only issues labelled with
251+
Only issues labelled with
242252
<span class="gh-label has-text-white" style="background-color: #333333;">
243253
🚦 status: awaiting triage
244254
</span>
245255
are allowed to not have all mandatory labels (seeing as they have not been
246256
triaged yet).
247257

248258
Categories not marked with an `*` are optional and it is upto the discretion of
249-
the maintainers to have apply labels from those categories to issues.
259+
the maintainers to have apply labels from those categories to issues.

0 commit comments

Comments
Β (0)