8
8
< meta property ="og:title " content ="Repository Labels " />
9
9
10
10
11
- < meta property ="og:description " content ="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. " />
11
+ < meta property ="og:description " content ="To facilitate the community in finding ways to contribute that
12
+ match their experiences and skillsets, we have developed a comprehensive system
13
+ for labelling issues and PRs. This is an introduction to this standard
14
+ labelling scheme. " />
12
15
13
16
< meta property ="og:url " content ="/contributing-code/repo-labels/ " />
14
17
< meta property ="og:type " content ="article " />
29
32
30
33
< meta name ="twitter:card " content ="summary_large_image " />
31
34
< meta name ="twitter:title " content ="Repository Labels ">
32
- < meta name ="twitter:description " content ="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. ">
35
+ < meta name ="twitter:description " content ="To facilitate the community in finding ways to contribute that
36
+ match their experiences and skillsets, we have developed a comprehensive system
37
+ for labelling issues and PRs. This is an introduction to this standard
38
+ labelling scheme. ">
33
39
34
40
< meta name ="twitter:site " content ="@creativecommons ">
35
41
< meta name ="twitter:creator " content ="@creativecommons ">
223
229
< div class ="container is-paddingless ">
224
230
< h1 > Repository Labels</ h1 >
225
231
< div class ="description column is-9 is-paddingless ">
226
- < p > 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.</ p >
232
+ < p > To facilitate the community in finding ways to contribute that
233
+ match their experiences and skillsets, we have developed a comprehensive system
234
+ for labelling issues and PRs. This is an introduction to this standard
235
+ labelling scheme.</ p >
227
236
228
237
</ div >
229
238
</ div >
@@ -326,9 +335,9 @@ <h4 class="b-header">On this page</h4>
326
335
</ div >
327
336
</ div >
328
337
< div class ="column content is-three-quarters ">
329
- < p > Labels consist of three fields, viz. name, description and color. Label names
330
- should have a consistent format to aid both filtering within the github UI as
331
- well as scanning visually through the list. The following format is the most
338
+ < p > Labels consist of three fields, viz. name, description and color. Label names
339
+ should have a consistent format to aid both filtering within the github UI as
340
+ well as scanning visually through the list. The following format is the most
332
341
suited to this task (where < code > ⎵</ code > denotes a single space):</ p >
333
342
< pre > < code > <emoji>⎵<category>:⎵<name>
334
343
</ code > </ pre >
@@ -368,8 +377,8 @@ <h3 id="priority">*Priority</h3><div class="table-container">
368
377
</ tr >
369
378
</ tbody >
370
379
</ table >
371
- </ div > < p > The priority of an issue is based on its impact, derived from a combination of
372
- urgency and importance. This determines the importance of the issue when sprint
380
+ </ div > < p > The priority of an issue is based on its impact, derived from a combination of
381
+ urgency and importance. This determines the importance of the issue when sprint
373
382
planning or deciding which issues to tackle next.</ p >
374
383
< ul >
375
384
< li > < span class ="gh-label priority-unfavourable ">
@@ -424,20 +433,20 @@ <h3 id="status">*Status</h3><div class="table-container">
424
433
</ div > < p > The status of the issue determines whether it is ready for work or not. Issues
425
434
may not be ready to be worked on for a number of reasons and the maintainers
426
435
must keep updating the labels as the situation evolves.</ p >
427
- < p > An issue, at the time of closing can have either the
436
+ < p > An issue, at the time of closing can have either the
428
437
< span class ="gh-label status-light ">
429
438
🏁 status: ready for dev
430
439
</ span >
431
- or the
440
+ or the
432
441
< span class ="gh-label status-lighter ">
433
442
⛔️ status: discarded
434
443
</ span >
435
444
label based on whether it was closed with or without resolution, respectively.</ p >
436
445
< ul >
437
- < li > < span class ="gh-label status-light ">
438
- 🏁 status: ready for dev
446
+ < li > < span class ="gh-label status-darker ">
447
+ 🚦 status: awaiting triage
439
448
</ span > < ul >
440
- < li > < strong > Description:</ strong > Ready for work</ li >
449
+ < li > < strong > Description:</ strong > Has not been triaged & therefore, not ready for work</ li >
441
450
</ ul >
442
451
</ li >
443
452
< li > < span class ="gh-label status-neutral ">
@@ -446,18 +455,6 @@ <h3 id="status">*Status</h3><div class="table-container">
446
455
< li > < strong > Description:</ strong > Blocked & therefore, not ready for work</ li >
447
456
</ ul >
448
457
</ li >
449
- < li > < span class ="gh-label status-dark ">
450
- 🧹 status: ticket work required
451
- </ span > < ul >
452
- < li > < strong > Description:</ strong > Needs more details before it can be worked on</ li >
453
- </ ul >
454
- </ li >
455
- < li > < span class ="gh-label status-dark ">
456
- 🏷 status: label work required
457
- </ span > < ul >
458
- < li > < strong > Description:</ strong > Needs proper labelling before it can be worked on</ li >
459
- </ ul >
460
- </ li >
461
458
< li > < span class ="gh-label status-lighter ">
462
459
⛔️ status: discarded
463
460
</ span > < ul >
@@ -470,10 +467,22 @@ <h3 id="status">*Status</h3><div class="table-container">
470
467
< li > < strong > Description:</ strong > Not suitable for work as repo is in maintenance</ li >
471
468
</ ul >
472
469
</ li >
473
- < li > < span class ="gh-label status-darker ">
474
- 🚦 status: awaiting triage
470
+ < li > < span class ="gh-label status-dark ">
471
+ 🏷 status: label work required
475
472
</ span > < ul >
476
- < li > < strong > Description:</ strong > Has not been triaged & therefore, not ready for work</ li >
473
+ < li > < strong > Description:</ strong > Needs proper labelling before it can be worked on</ li >
474
+ </ ul >
475
+ </ li >
476
+ < li > < span class ="gh-label status-light ">
477
+ 🏁 status: ready for dev
478
+ </ span > < ul >
479
+ < li > < strong > Description:</ strong > Ready for work</ li >
480
+ </ ul >
481
+ </ li >
482
+ < li > < span class ="gh-label status-dark ">
483
+ 🧹 status: ticket work required
484
+ </ span > < ul >
485
+ < li > < strong > Description:</ strong > Needs more details before it can be worked on</ li >
477
486
</ ul >
478
487
</ li >
479
488
</ ul >
@@ -484,37 +493,41 @@ <h3 id="goal">*Goal</h3><p>The goal of an issue is the end-result achieved when
484
493
< li > < strong > Description:</ strong > Addition of new feature</ li >
485
494
</ ul >
486
495
</ li >
487
- < li > < span class ="gh-label goal "> ✨ goal: improvement</ span > < ul >
488
- < li > < strong > Description:</ strong > Improvement to an existing feature</ li >
489
- </ ul >
490
- </ li >
491
496
< li > < span class ="gh-label goal "> 🛠 goal: fix</ span > < ul >
492
497
< li > < strong > Description:</ strong > Bug fix</ li >
493
498
</ ul >
494
499
</ li >
500
+ < li > < span class ="gh-label goal "> ✨ goal: improvement</ span > < ul >
501
+ < li > < strong > Description:</ strong > Improvement to an existing feature</ li >
502
+ </ ul >
503
+ </ li >
495
504
</ ul >
496
505
< h3 id ="aspect "> *Aspect</ h3 > < p > The aspect of an issue is the side of the project that the issue deals with. A
497
506
single codebase can have multiple aspects to it and knowing which ones will be
498
507
touched helps contributors find relevant issues.</ p >
499
508
< ul >
500
- < li > < span class ="gh-label aspect "> 📄 aspect: text</ span > < ul >
501
- < li > < strong > Description:</ strong > Concerns the textual material in the repository</ li >
502
- </ ul >
503
- </ li >
504
509
< li > < span class ="gh-label aspect "> 💻 aspect: code</ span > < ul >
505
510
< li > < strong > Description:</ strong > Concerns the software code in the repository</ li >
506
511
</ ul >
507
512
</ li >
508
- < li > < span class ="gh-label aspect "> 🕹 aspect: interface </ span > < ul >
509
- < li > < strong > Description:</ strong > Concerns end-users' experience with the software </ li >
513
+ < li > < span class ="gh-label aspect "> 📖 aspect: docs </ span > < ul >
514
+ < li > < strong > Description:</ strong > Concerns the documentation in the repository </ li >
510
515
</ ul >
511
516
</ li >
512
517
< li > < span class ="gh-label aspect "> 🤖 aspect: dx</ span > < ul >
513
518
< li > < strong > Description:</ strong > Concerns developers' experience with the codebase</ li >
514
519
</ ul >
515
520
</ li >
521
+ < li > < span class ="gh-label aspect "> 🕹 aspect: interface</ span > < ul >
522
+ < li > < strong > Description:</ strong > Concerns end-users' experience with the software</ li >
523
+ </ ul >
524
+ </ li >
525
+ < li > < span class ="gh-label aspect "> 📄 aspect: text</ span > < ul >
526
+ < li > < strong > Description:</ strong > Concerns the textual material in the repository</ li >
516
527
</ ul >
517
- < h3 id ="skill "> Skill</ h3 > < p > The technical skills a person is required to possess to work on the issue.
528
+ </ li >
529
+ </ ul >
530
+ < h3 id ="skill "> Skill</ h3 > < p > The technical skills a person is required to possess to work on the issue.
518
531
Skills are a special type of label that vary by repository. Issues may not have
519
532
a skill tag if no special skills are required.</ p >
520
533
< ul >
@@ -524,24 +537,24 @@ <h3 id="skill">Skill</h3><p>The technical skills a person is required to possess
524
537
</ li >
525
538
</ ul >
526
539
< h3 id ="talk "> Talk</ h3 > < p > Issues with interaction labels do not entail any work to be done on the
527
- repository. They are for Q&A, RFCs and any other form of discussions. While both
528
- of these may appear to be too similar, triage permissions are granted to
540
+ repository. They are for Q&A, RFCs and any other form of discussions. While
541
+ both of these may appear to be too similar, triage permissions are granted to
529
542
collaborators who might not have the answers to questions but by labelling them
530
543
as such, they might draw a faster response from an experienced contributor who
531
- does. < em > In the future this category might be rendered redundant by GitHub
544
+ does. < em > In the future this category might be rendered redundant by GitHub
532
545
Discussions and will be removed.</ em > </ p >
533
546
< ul >
534
- < li > < span class ="gh-label talk "> ❓ talk: question</ span > < ul >
535
- < li > < strong > Description:</ strong > Can be resolved with an answer</ li >
536
- </ ul >
537
- </ li >
538
547
< li > < span class ="gh-label talk "> 💬 talk: discussion</ span > < ul >
539
548
< li > < strong > Description:</ strong > Open for discussions and feedback</ li >
540
549
</ ul >
541
550
</ li >
551
+ < li > < span class ="gh-label talk "> ❓ talk: question</ span > < ul >
552
+ < li > < strong > Description:</ strong > Can be resolved with an answer</ li >
553
+ </ ul >
554
+ </ li >
542
555
</ ul >
543
- < h3 id ="friendliness "> Friendliness</ h3 > < p > The level of friendliness a particular issue is the valency of the issue
544
- towards contributions from the community. Some issues provide a great
556
+ < h3 id ="friendliness "> Friendliness</ h3 > < p > The level of friendliness a particular issue is the valency of the issue
557
+ towards contributions from the community. Some issues provide a great
545
558
introduction while others require a little more familiarity with the codebase.
546
559
< em > These issues do not have the category prefix as two of them are special labels
547
560
recognized by GitHub. The special ones don't have emojis either.</ em > </ p >
@@ -566,12 +579,6 @@ <h3 id="miscellaneous">Miscellaneous</h3><ul>
566
579
< li > < strong > Description:</ strong > Aaargh!</ li >
567
580
</ ul >
568
581
</ li >
569
- < li > < span class ="gh-label hacktoberfest ">
570
- Hacktoberfest
571
- </ span > < ul >
572
- < li > < strong > Description:</ strong > Good issues for Hacktoberfest participants</ li >
573
- </ ul >
574
- </ li >
575
582
< li > < span class ="gh-label invalid ">
576
583
invalid
577
584
</ span > < ul >
@@ -582,7 +589,7 @@ <h3 id="miscellaneous">Miscellaneous</h3><ul>
582
589
< h2 id ="usage-rules "> Usage rules</ h2 > < p > In the above categories, some are marked with an < code > *</ code > sign. Those are mandatory
583
590
categories and every issue is required to have at least one label from those
584
591
categories.</ p >
585
- < p > Only issues labelled with
592
+ < p > Only issues labelled with
586
593
< span class ="gh-label has-text-white " style ="background-color: #333333; ">
587
594
🚦 status: awaiting triage
588
595
</ span >
0 commit comments