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
@@ -99,71 +99,161 @@ 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, in order to avoid non-updating scenarios. States should be defined in project section.
102
+
GitHub labels should define immutable informations about issues. States should be defined in project section.
103
+
104
+
*Why*
105
+
>To avoid non-updated scenarios.
106
+
107
+
#### Examples
108
+
109
+
<details>
110
+
<summary>Excelsior Approved</summary>
103
111
104
-
**Preferred:**
105
112
```markdown
106
113
- type
107
114
- severity
108
115
```
109
116
110
-
**Not Preferred:**
117
+
</details>
118
+
<details>
119
+
<summary>Not Recommended</summary>
120
+
111
121
```markdown
112
122
- priority
113
123
- status
114
124
```
115
125
126
+
</details>
127
+
116
128
### Colors
117
129
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.
130
+
It is better to use similar color styling accross categories for a stronger visual identification. Colors should be variants of Red-Orange-Green to provide a sense of state. Red being the ones that require the most attention. Green being the ones that require little attention.
131
+
132
+
*Why*
133
+
>Red-Orange-Green variations are commonly used internationally to provide a sense of state. Keeping same color styling accross categories is key for a strong and clear visual identification.
134
+
135
+
**Excelsior Format:**
136
+
137
+
```markdown
138
+
-`Low`: green
139
+
-`Medium`: orange
140
+
-`Critical`: red
141
+
```
142
+
143
+
#### Examples
144
+
145
+
<details>
146
+
<summary>Excelsior Approved</summary>
119
147
120
-
**Preferred:**
121
148
```markdown
122
149
-`Severity: Low`: green
150
+
```
151
+
```markdown
123
152
-`Severity: Medium`: orange
153
+
```
154
+
```markdown
124
155
-`Severity: Critical`: red
156
+
```
157
+
```markdown
125
158
-`Change: Minor`: green
159
+
```
160
+
```markdown
126
161
-`Change: Medium`: orange
162
+
```
163
+
```markdown
127
164
-`Change: Master`: red
128
165
```
129
166
130
-
**Not Preferred:**
167
+
</details>
168
+
<details>
169
+
<summary>Not Recommended</summary>
170
+
131
171
```markdown
132
172
-`Severity: Low`: blue
173
+
```
174
+
```markdown
133
175
-`Severity: Medium`: blue
176
+
```
177
+
```markdown
134
178
-`Severity: Critical`: blue
179
+
```
180
+
```markdown
135
181
-`Change: Minor`: green
182
+
```
183
+
```markdown
136
184
-`Change: Medium`: green
185
+
```
186
+
```markdown
137
187
-`Change: Master`: green
138
188
```
139
189
190
+
</details>
191
+
140
192
### Categories
141
193
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.
194
+
Labels should help reviewers to quickly get information about the reviewing effort. Labels should be regrouped into categories. Issues cannot have more than one label from the same category.
195
+
196
+
*Why*
197
+
>To provide the consistent information for every issue.
198
+
199
+
**Excelsior Format:**
200
+
201
+
```markdown
202
+
-`Caterogy: Type`
203
+
```
204
+
205
+
#### Examples
206
+
207
+
<details>
208
+
<summary>Excelsior Approved</summary>
143
209
144
-
**Preferred:**
145
210
```markdown
146
211
-`Severity: Low`
212
+
```
213
+
```markdown
147
214
-`Severity: Medium`
215
+
```
216
+
```markdown
148
217
-`Severity: Critical`
218
+
```
219
+
```markdown
149
220
-`Change: Minor`
221
+
```
222
+
```markdown
150
223
-`Change: Medium`
224
+
```
225
+
```markdown
151
226
-`Change: Master`
152
227
```
153
228
154
-
**Not Preferred:**
229
+
</details>
230
+
<details>
231
+
<summary>Not Recommended</summary>
232
+
155
233
```markdown
156
234
-`Low`
235
+
```
236
+
```markdown
157
237
-`Medium`
238
+
```
239
+
```markdown
158
240
-`Critical`
241
+
```
242
+
```markdown
159
243
-`Blocked`
244
+
```
245
+
```markdown
160
246
-`Feature`
247
+
```
248
+
```markdown
161
249
-`WorkInProgress`
162
250
```
163
251
252
+
</details>
253
+
164
254
*Pro tip:* GitHub orders labels aphabetically, so following this format allows to keep categories dislayed in the same order accross every issues.
165
255
166
-
#### Type
256
+
#### Type Category
167
257
168
258
Type labels should be used to define the type of task done inside the issue.
169
259
@@ -179,7 +269,7 @@ The issue is a suggestion of enhancement to your project.
179
269
-`Type: Documentation`**#c3b2ef**
180
270
The issue is the creation or refinement of a document.
181
271
182
-
#### Severity
272
+
#### Severity Category
183
273
184
274
Severity labels are mostly used for bug-related issues. It allows to identify the critical aspects of the work implied inside the issue.
185
275
@@ -201,7 +291,7 @@ The issue reports cosmetic items, formatting, spelling, colors, etc.
201
291
-`Severity: Low`**#c3b2ef**
202
292
The issue concerns a new feature or any addition to the project.
203
293
204
-
#### Type of change
294
+
#### Type Of Change Category
205
295
206
296
Type of change labels are only used for pull requests. They give information about the effort needed to review a pull request. We strongly recommend to define core areas to help define the estimated effort.
0 commit comments