You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+49-26Lines changed: 49 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,46 +99,69 @@ Templates should promote a high contribution quality by referring [contributing
99
99
100
100
### Immutablity
101
101
102
-
GitHub labels should define immutable informations about issues.
102
+
GitHub labels should define immutable informations about issues, in order to avoid non-updating scenarios. States should be defined in project section.
103
103
104
-
*Why*
105
-
>Having to change labels over time is a bad practice. Indeed, changing labels manually multiple times on issues can be very time consumming and prone to errors. Moreover, if the information about the issue is changing, it is surely not a relevant information to have as a label. Almost everytime, any variable information about an issue can be managed in another way which will be much more efficient in the end. Considering this will tremendously reduce useless labels creation.
104
+
**Preferred:**
105
+
```markdown
106
+
- type
107
+
- severity
108
+
```
106
109
107
-
### Colors
110
+
**Not Preferred:**
111
+
```markdown
112
+
- priority
113
+
- status
114
+
```
108
115
109
-
It is better to use similar color styling accross categories for a stronger visual identification.
116
+
### Colors
110
117
111
-
*Why*
112
-
>Keeping same color styling accross categories is key for a strong and clear visual identification.
118
+
Colors should be variants of Red-Orange-Green to provide a sense of state. It is better to use similar color styling accross categories for a stronger visual identification. Red being the ones that require the most attention. Green being the ones that require little attention.
113
119
114
-
Colors should be variants of Red-Orange-Green.
120
+
**Preferred:**
121
+
```markdown
122
+
-`Severity: Low`: green
123
+
-`Severity: Medium`: orange
124
+
-`Severity: Critical`: red
125
+
-`Change: Minor`: green
126
+
-`Change: Medium`: orange
127
+
-`Change: Master`: red
128
+
```
115
129
116
-
*Why*
117
-
>Red-Orange-Green variations are commonly used internationally to provide a sense of state. Red being the ones that require the most attention. Green being the ones that require little attention.
130
+
**Not Preferred:**
131
+
```markdown
132
+
-`Severity: Low`: blue
133
+
-`Severity: Medium`: blue
134
+
-`Severity: Critical`: blue
135
+
-`Change: Minor`: green
136
+
-`Change: Medium`: green
137
+
-`Change: Master`: green
138
+
```
118
139
119
140
### Categories
120
141
121
-
Labels should be regrouped into categories. Only three of them are needed.
122
-
123
-
*Why*
124
-
>Categories help identify what label to assign to an issue. Each issue cannot have more than one label from the same category.
125
-
126
-
Labels should have the following format `Category: Name`.
127
-
128
-
*Why*
129
-
>Having this format allows to be explicit about the category of the label. Also, GitHub orders labels aphabetically, so following this format allows to keep categories dislayed in the same order accross every issues.
142
+
Labels should help reviewers to quickly get information about the reviewing effort. Labels should be categorized to provide the same amount of information for each issue. Issues cannot have more than one label from the same category.
130
143
131
144
**Preferred:**
132
-
`Type: Bug`
145
+
```markdown
146
+
-`Severity: Low`
147
+
-`Severity: Medium`
148
+
-`Severity: Critical`
149
+
-`Change: Minor`
150
+
-`Change: Medium`
151
+
-`Change: Master`
152
+
```
133
153
134
154
**Not Preferred:**
135
-
`Bug`
136
-
137
-
138
-
Every issue should have a `Type` and a `Severity` label.
155
+
```markdown
156
+
-`Low`
157
+
-`Medium`
158
+
-`Critical`
159
+
-`Blocked`
160
+
-`Feature`
161
+
-`WorkInProgress`
162
+
```
139
163
140
-
*Why*
141
-
>Having the same labels on every issue helps for visual consistency. Also, these are necessary informations for any issue.
164
+
*Pro tip:* GitHub orders labels aphabetically, so following this format allows to keep categories dislayed in the same order accross every issues.
0 commit comments