|
1 | 1 | # Repository labels to be synced across the entire org.
|
2 | 2 | # Every item must have a name, color, and description.
|
| 3 | + |
3 | 4 | # Notes:
|
4 | 5 | # * Repositories may define their own labels as long as they don't
|
5 |
| -# conflict with what's listed here. |
| 6 | +# conflict with what's listed here. If it turns out a repository-specific |
| 7 | +# label would be useful to have in the entire organization, we can always add |
| 8 | +# it here post facto. |
| 9 | +# * We have added these based on need. They are not all-encompassing. If something |
| 10 | +# seems missing, feel free to open a PR. |
6 | 11 | # * Whenever a repo has a matching label, that label will be updated. If there
|
7 | 12 | # is no matching label, the label will be created anew. "Matching" is determined
|
8 | 13 | # by comparing the label's lowercased name, with all puncutation, emoji, and special
|
9 | 14 | # chars removed.
|
10 | 15 | # * For picking hex colors, you might use: https://www.htmlcolor-picker.com/
|
| 16 | +# Describe your color with a comment so it's easier to review. |
| 17 | + |
11 | 18 |
|
12 |
| -### COMMUNITY LABELS |
| 19 | +### LABELS INDICATING HOW ISSUES CAN BE ENAGAGED WITH. |
13 | 20 |
|
14 | 21 | - name: "good first issue"
|
15 | 22 | color: "42dd35" # friendly lime green
|
16 | 23 | description: "A good task for a newcomer to start with"
|
17 | 24 |
|
18 | 25 | - name: "help wanted"
|
19 | 26 | color: "54976d" # fenway green
|
20 |
| - description: "Ready to be picke up by anyone in the community" |
21 |
| - |
22 |
| -- name: "DEPR" |
23 |
| - color: "3c3cc3" # indigo-blue |
24 |
| - description: "Proposal for depreaction & removal per OEP-21" |
| 27 | + description: "Ready to be picked up by anyone in the community" |
25 | 28 |
|
26 | 29 |
|
27 |
| -### KINDS OF WORK |
| 30 | +### LABELS INDICATING BROAD THEMES OF WORK. |
| 31 | +### MORE THAN ONE OF THESE MAY APPLY AT A TIME. |
28 | 32 |
|
29 | 33 | - name: "maintenance"
|
30 | 34 | color: "ff9125" # construction orange
|
31 |
| - description: "Work that must be done for platform health" |
| 35 | + description: "Relates to platform health and/or routine upkeep" |
32 | 36 |
|
33 |
| -- name: "discovery" |
34 |
| - color: "d876e3" # a curious shade of lavendar |
35 |
| - description: "Pre-work to determine if an idea is feasible" |
36 |
| - |
37 |
| -- name: "bug" |
38 |
| - color: "d93f0b" # scarlet red |
39 |
| - description: "Something isn't working" |
| 37 | +- name: "security" |
| 38 | + color: "f0d165" # caution yellow |
| 39 | + description: "Relates to improving to the security posture of the platform" |
40 | 40 |
|
41 | 41 | - name: "enhancement"
|
42 |
| - color: "a2eeef" # refreshing light teal |
43 |
| - description: "Update or improvement to an existing feature" |
| 42 | + color: "a2eeef" # electric blue! |
| 43 | + description: "Relates to new features or improvements to existing features" |
| 44 | + |
| 45 | +- name: "documentation" |
| 46 | + color: "0052cc" # royal blue |
| 47 | + description: "Relates to documentation improvements" |
44 | 48 |
|
45 |
| -- name: "feature" |
46 |
| - color: "05d1dc" # teal for real |
47 |
| - description: "Addition of new functionality" |
48 | 49 |
|
| 50 | +### LABELS INDICATING THE SCOPE OR FUNCTION OF THE ISSUE. |
| 51 | +### AT MOST ONE OF THESE SHOULD BE USED AT A TIME. |
| 52 | + |
| 53 | +- name: "depr" |
| 54 | + color: "3c3cc3" # indigo-blue |
| 55 | + description: "Proposal for deprecation & removal per OEP-21" |
| 56 | + |
| 57 | +- name: "bug" |
| 58 | + color: "d93f0b" # scarlet red... |
| 59 | + description: "Report of or fix for something that isn't working as intended" |
49 | 60 |
|
50 |
| -### SCOPES OF WORK |
| 61 | +- name: "discovery" |
| 62 | + color: "d876e3" # a curious shade of lavendar |
| 63 | + description: "Pre-work to determine if an idea is feasible" |
51 | 64 |
|
52 | 65 | - name: "epic"
|
53 | 66 | color: "7e027e" # epic violet
|
|
58 | 71 | description: "Huge unit of work, consisting of multiple epics"
|
59 | 72 |
|
60 | 73 |
|
61 |
| -### ISSUE OUTCOMES |
| 74 | +### LABELS INDICATING ISSUE OUTCOMES. |
62 | 75 |
|
63 | 76 | - name: "wontfix"
|
64 | 77 | color: "ffffff" # white
|
|
69 | 82 | description: "This issue or pull request already exists elsewhere"
|
70 | 83 |
|
71 | 84 |
|
72 |
| -### PR TRIAGE WORKFLOW |
| 85 | +### LABELS USED IN THE OPEN EDX CONTRIBUTION WORKFLOW. |
| 86 | +### PLEASE CONSULT WITH OPEN EDX PROJECT MANAGMENT BEFORE CHANGING THESE. |
73 | 87 |
|
74 | 88 | - name: "waiting on author"
|
75 | 89 | color: "bfd6f6" # baby blue
|
|
79 | 93 | color: "cc950a" # clay-ish brown
|
80 | 94 | description: "PR author has been unresponsive for several months"
|
81 | 95 |
|
82 |
| -- name: "closed-inactivity" |
| 96 | +- name: "closed inactivity" |
83 | 97 | color: "dbcd00" # gold
|
84 | 98 | description: "PR was closed because the author abandoned it"
|
85 | 99 |
|
86 | 100 | - name: "needs test run"
|
87 | 101 | color: "f5424b" # crimson red
|
88 | 102 | description: "Author's first PR to a repository, awaiting test authorization from Axim"
|
89 | 103 |
|
90 |
| -- name: "core contributor" |
91 |
| - color: "000000" # black |
92 |
| - description: "PR is Core Contributor with rights in this repository (manually added)" |
93 |
| - |
94 |
| -- name: "open-source-contribution" |
| 104 | +- name: "open source contribution" |
95 | 105 | color: "f0f0f0" # light grey
|
96 | 106 | description: "PR author is not from Axim or 2U"
|
97 | 107 |
|
98 | 108 | - name: "blocked by other work"
|
99 | 109 | color: "ffa500" # yellow orange
|
100 | 110 | description: "PR cannot be finished until other work is complete"
|
101 | 111 |
|
102 |
| -- name: "changes requested" |
103 |
| - color: "76a4e3" # cornflower blue |
104 |
| - description: "PR reviewers are waiting on author to apply feedback" |
105 |
| - |
106 | 112 | - name: "product review"
|
107 | 113 | color: "c97bf7" # light puple
|
108 | 114 | description: "PR requires product review before merging"
|
| 115 | + |
| 116 | +- name: "core contributor" |
| 117 | + color: "000000" # black |
| 118 | + description: "PR is Core Contributor with rights in this repository (manually added)" |
0 commit comments