Skip to content

Commit dca1d25

Browse files
romsiromsi
committed
Add color example instead of showing hex color only.
1 parent 838e5d6 commit dca1d25

1 file changed

Lines changed: 38 additions & 131 deletions

File tree

‎README.md‎

Lines changed: 38 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -99,213 +99,120 @@ Templates should promote a high contribution quality by referring [contributing
9999

100100
### Immutablity
101101

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>
102+
GitHub labels should define immutable informations about issues, in order to avoid non-updating scenarios. States should be defined in project section.
111103

104+
**Preferred:**
112105
```markdown
113106
- type
114107
- severity
115108
```
116109

117-
</details>
118-
<details>
119-
<summary>Not Recommended</summary>
120-
110+
**Not Preferred:**
121111
```markdown
122112
- priority
123113
- status
124114
```
125115

126-
</details>
127-
128116
### Colors
129117

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
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.
136119

137-
```markdown
138-
- `Low`: green
139-
- `Medium`: orange
140-
- `Critical`: red
141-
```
142-
143-
#### Examples
144-
145-
<details>
146-
<summary>Excelsior Approved</summary>
147-
148-
```markdown
149-
- `Severity: Low`: green
150-
```
151-
```markdown
152-
- `Severity: Medium`: orange
153-
```
154-
```markdown
155-
- `Severity: Critical`: red
156-
```
157-
```markdown
158-
- `Change: Minor`: green
159-
```
160-
```markdown
161-
- `Change: Medium`: orange
162-
```
163-
```markdown
164-
- `Change: Master`: red
165-
```
120+
**Preferred:**
166121

167-
</details>
168-
<details>
169-
<summary>Not Recommended</summary>
122+
- `Severity: Low`: ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
123+
- `Severity: Medium`: ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
124+
- `Severity: Critical`: ![#ffe700](https://placehold.it/15/ffe700/000000?text=+)
125+
- `Change: Minor`: ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
126+
- `Change: Medium`: ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
127+
- `Change: Master`: ![#ffe700](https://placehold.it/15/ffe700/000000?text=+)
170128

171-
```markdown
172-
- `Severity: Low`: blue
173-
```
174-
```markdown
175-
- `Severity: Medium`: blue
176-
```
177-
```markdown
178-
- `Severity: Critical`: blue
179-
```
180-
```markdown
181-
- `Change: Minor`: green
182-
```
183-
```markdown
184-
- `Change: Medium`: green
185-
```
186-
```markdown
187-
- `Change: Master`: green
188-
```
129+
**Not Preferred:**
189130

190-
</details>
131+
- `Severity: Low`: ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
132+
- `Severity: Medium`: ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
133+
- `Severity: Critical`: ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
134+
- `Change: Minor`: ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
135+
- `Change: Medium`: ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
136+
- `Change: Master`: ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
191137

192138
### Categories
193139

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>
140+
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.
209141

142+
**Preferred:**
210143
```markdown
211144
- `Severity: Low`
212-
```
213-
```markdown
214145
- `Severity: Medium`
215-
```
216-
```markdown
217146
- `Severity: Critical`
218-
```
219-
```markdown
220147
- `Change: Minor`
221-
```
222-
```markdown
223148
- `Change: Medium`
224-
```
225-
```markdown
226149
- `Change: Master`
227150
```
228151

229-
</details>
230-
<details>
231-
<summary>Not Recommended</summary>
232-
152+
**Not Preferred:**
233153
```markdown
234154
- `Low`
235-
```
236-
```markdown
237155
- `Medium`
238-
```
239-
```markdown
240156
- `Critical`
241-
```
242-
```markdown
243157
- `Blocked`
244-
```
245-
```markdown
246158
- `Feature`
247-
```
248-
```markdown
249159
- `WorkInProgress`
250160
```
251161

252-
</details>
253-
254-
255162
*Pro tip:* GitHub orders labels aphabetically, so following this format allows to keep categories dislayed in the same order accross every issues.
256163

257-
#### Type Category
164+
#### Type
258165

259166
Type labels should be used to define the type of task done inside the issue.
260167

261-
- `Type: Feature` **#00cc41**
168+
- `Type: Feature` ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
262169
The issue is the development of a new feature of your project.
263170

264-
- `Type: Bug` **#ff0000**
171+
- `Type: Bug` ![#ff0000](https://placehold.it/15/ff0000/000000?text=+)
265172
The issue is an identified bug that needs to be fixed.
266173

267-
- `Type: Enhancement` **#ffe700**
174+
- `Type: Enhancement` ![#ffe700](https://placehold.it/15/ffe700/000000?text=+)
268175
The issue is a suggestion of enhancement to your project.
269176

270-
- `Type: Documentation` **#c3b2ef**
177+
- `Type: Documentation` ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
271178
The issue is the creation or refinement of a document.
272179

273-
#### Severity Category
180+
#### Severity
274181

275182
Severity labels are mostly used for bug-related issues. It allows to identify the critical aspects of the work implied inside the issue.
276183

277-
- `Severity: Blocker`**#ff0000**
184+
- `Severity: Blocker` ![#000000](https://placehold.it/15/000000/000000?text=+)
278185
The issue is blocking an impending release.
279186

280-
- `Severity: Critical` **#ff4000**
187+
- `Severity: Critical` ![#ff4000](https://placehold.it/15/ff4000/000000?text=+)
281188
The issue causes data loss, crashes or hangs salt processes, makes the system unresponsive, etc.
282189

283-
- `Severity: High` **#ff8100**
190+
- `Severity: High` ![#ff8100](https://placehold.it/15/ff8100/000000?text=+)
284191
The issue reports incorrect functionality, bad functionality, a confusing user experience, etc.
285192

286-
- `Severity: Strong` **#ffe700**
193+
- `Severity: Strong` ![#ffe700](https://placehold.it/15/ffe700/000000?text=+)
287194
The issue concerns changes to the core areas of the project.
288195

289-
- `Severity: Medium` **#00cc41**
196+
- `Severity: Medium` ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
290197
The issue reports cosmetic items, formatting, spelling, colors, etc.
291198

292-
- `Severity: Low` **#c3b2ef**
199+
- `Severity: Low` ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
293200
The issue concerns a new feature or any addition to the project.
294201

295-
#### Type Of Change Category
202+
#### Type of change
296203

297204
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.
298205

299-
- `Change: Minor` **#c3b2ef**
206+
- `Change: Minor` ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
300207
Less than 64 lines changed, or less than 8 core lines changed.
301208

302-
- `Change: Medium` **#00cc41**
209+
- `Change: Medium` ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
303210
Less than 256 lines changed, or less than 64 core lines changed.
304211

305-
- `Change: Master` **#ffe700**
212+
- `Change: Master` ![#ffe700](https://placehold.it/15/ffe700/000000?text=+)
306213
More than 256 lines changed, or more than 64 core lines changed.
307214

308-
- `Change: Expert`**#ff0000**
215+
- `Change: Expert` ![#ff0000](https://placehold.it/15/ff0000/000000?text=+)
309216
Needs specialized, in-depth review.
310217

311218
## CHANGELOG

0 commit comments

Comments
 (0)