Skip to content

Commit 67c8e06

Browse files
authored
Improve preferred/not preferred examples for label section.
1 parent dca1d25 commit 67c8e06

1 file changed

Lines changed: 33 additions & 68 deletions

File tree

README.md

Lines changed: 33 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -95,22 +95,22 @@ Templates should promote a high contribution quality by referring [contributing
9595

9696
## Milestone
9797

98-
## Labels
98+
## Label
9999

100100
### Immutablity
101101

102102
GitHub labels should define immutable informations about issues, in order to avoid non-updating scenarios. States should be defined in project section.
103103

104104
**Preferred:**
105105
```markdown
106-
- type
107-
- severity
106+
- Type: Feature
107+
- Severity: Low
108108
```
109109

110110
**Not Preferred:**
111111
```markdown
112-
- priority
113-
- status
112+
- WorkInProgress
113+
- Critical
114114
```
115115

116116
### Colors
@@ -119,44 +119,34 @@ Colors should be variants of Red-Orange-Green to provide a sense of state. It is
119119

120120
**Preferred:**
121121

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=+)
122+
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) `Severity: Low`
123+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Severity: Medium`
124+
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) `Change: Minor`
125+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Change: Medium`
128126

129127
**Not Preferred:**
130128

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=+)
129+
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) `Severity: Low`
130+
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) `Severity: Medium`
131+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Change: Minor`
132+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Change: Medium`
137133

138134
### Categories
139135

140136
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.
141137

142138
**Preferred:**
143139
```markdown
144-
- `Severity: Low`
145-
- `Severity: Medium`
146-
- `Severity: Critical`
147-
- `Change: Minor`
148-
- `Change: Medium`
149-
- `Change: Master`
140+
- Type: Documentation
141+
- Severity: Medium
142+
- Change: Minor
150143
```
151144

152145
**Not Preferred:**
153146
```markdown
154-
- `Low`
155-
- `Medium`
156-
- `Critical`
157-
- `Blocked`
158-
- `Feature`
159-
- `WorkInProgress`
147+
- Question
148+
- Feature
149+
- Documentation
160150
```
161151

162152
*Pro tip:* GitHub orders labels aphabetically, so following this format allows to keep categories dislayed in the same order accross every issues.
@@ -165,55 +155,30 @@ Labels should help reviewers to quickly get information about the reviewing effo
165155

166156
Type labels should be used to define the type of task done inside the issue.
167157

168-
- `Type: Feature` ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
169-
The issue is the development of a new feature of your project.
170-
171-
- `Type: Bug` ![#ff0000](https://placehold.it/15/ff0000/000000?text=+)
172-
The issue is an identified bug that needs to be fixed.
173-
174-
- `Type: Enhancement` ![#ffe700](https://placehold.it/15/ffe700/000000?text=+)
175-
The issue is a suggestion of enhancement to your project.
176-
177-
- `Type: Documentation` ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
178-
The issue is the creation or refinement of a document.
158+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `Type: Feature`: The issue is the development of a new feature of your project.
159+
- ![#ff0000](https://placehold.it/15/ff0000/000000?text=+) (**#ff0000**) `Type: Bug`: The issue is an identified bug that needs to be fixed.
160+
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Type: Enhancement`: The issue is a suggestion of enhancement to your project.
161+
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Type: Documentation`: The issue is the creation or refinement of a document.
179162

180163
#### Severity
181164

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

184-
- `Severity: Blocker` ![#000000](https://placehold.it/15/000000/000000?text=+)
185-
The issue is blocking an impending release.
186-
187-
- `Severity: Critical` ![#ff4000](https://placehold.it/15/ff4000/000000?text=+)
188-
The issue causes data loss, crashes or hangs salt processes, makes the system unresponsive, etc.
189-
190-
- `Severity: High` ![#ff8100](https://placehold.it/15/ff8100/000000?text=+)
191-
The issue reports incorrect functionality, bad functionality, a confusing user experience, etc.
192-
193-
- `Severity: Strong` ![#ffe700](https://placehold.it/15/ffe700/000000?text=+)
194-
The issue concerns changes to the core areas of the project.
195-
196-
- `Severity: Medium` ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
197-
The issue reports cosmetic items, formatting, spelling, colors, etc.
198-
199-
- `Severity: Low` ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
200-
The issue concerns a new feature or any addition to the project.
167+
- ![#000000](https://placehold.it/15/000000/000000?text=+) (**#000000**) `Severity: Blocker`: The issue is blocking an impending release.
168+
- ![#ff4000](https://placehold.it/15/ff4000/000000?text=+) (**#ff4000**) `Severity: Critical`: The issue causes data loss, crashes or hangs salt processes, makes the system unresponsive, etc.
169+
- ![#ff8100](https://placehold.it/15/ff8100/000000?text=+) (**#ff8100**) `Severity: High`: The issue reports incorrect functionality, bad functionality, a confusing user experience, etc.
170+
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Severity: Strong`: The issue concerns changes to the core areas of the project.
171+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `Severity: Medium`: The issue reports cosmetic items, formatting, spelling, colors, etc.
172+
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Severity: Low`: The issue concerns a new feature or any addition to the project.
201173

202174
#### Type of change
203175

204176
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.
205177

206-
- `Change: Minor` ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+)
207-
Less than 64 lines changed, or less than 8 core lines changed.
208-
209-
- `Change: Medium` ![#00cc41](https://placehold.it/15/00cc41/000000?text=+)
210-
Less than 256 lines changed, or less than 64 core lines changed.
211-
212-
- `Change: Master` ![#ffe700](https://placehold.it/15/ffe700/000000?text=+)
213-
More than 256 lines changed, or more than 64 core lines changed.
214-
215-
- `Change: Expert` ![#ff0000](https://placehold.it/15/ff0000/000000?text=+)
216-
Needs specialized, in-depth review.
178+
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Change: Minor`: Less than 64 lines changed, or less than 8 core lines changed.
179+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `Change: Medium`: Less than 256 lines changed, or less than 64 core lines changed.
180+
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Change: Master`: More than 256 lines changed, or more than 64 core lines changed.
181+
- ![#ff0000](https://placehold.it/15/ff0000/000000?text=+) (**#ff0000**) `Change: Expert`: Needs specialized, in-depth review.
217182

218183
## CHANGELOG
219184

0 commit comments

Comments
 (0)