Skip to content

Commit 7ab2a53

Browse files
committed
📝 Improve label section content.
- Add introduction for label section. - Fix typos. - Rearrange content for type of change section.
1 parent 9452bf8 commit 7ab2a53

1 file changed

Lines changed: 20 additions & 16 deletions

File tree

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ Templates should promote a high contribution quality by referring [contributing
9797

9898
## Label
9999

100+
Labels should help contributors and reviewers to evaluate effort for a specific issue or pull request.
101+
100102
### Immutablity
101103

102104
GitHub labels should define immutable informations about issues, in order to avoid non-updated scenarios. States should be defined in project section.
@@ -115,7 +117,7 @@ GitHub labels should define immutable informations about issues, in order to avo
115117

116118
### Colors
117119

118-
It is better to use similar color styling accross categories for a consistent and 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.
120+
Colors should help contributors and reviewers to quickly and visually identify the effort to be done. It is better to use similar color styling accross categories for a consistent and stronger visual identification. Colors should be variants of Red-Orange-Green to provide a sense of priority. Red being the ones that require the most attention. Green being the ones that require little attention.
119121

120122
**Preferred:**
121123

@@ -133,7 +135,7 @@ It is better to use similar color styling accross categories for a consistent an
133135

134136
### Categories
135137

136-
Labels should help reviewers to quickly get information about the reviewing effort. Labels should be regrouped into categories to provide consistent information about every issue. Issues cannot have more than one label from the same category.
138+
Labels should be regrouped into categories to provide consistent information about every issue. Issues cannot have more than one label from the same category.
137139

138140
**Preferred:**
139141
```markdown
@@ -153,33 +155,35 @@ Labels should help reviewers to quickly get information about the reviewing effo
153155

154156
#### Type
155157

156-
Type labels should be used to define the type of task done inside the issue.
158+
Type labels should be used to define the type of task done inside the issue:
157159

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.
160+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `Type: Feature`: The issue is the development of a new feature of your project
161+
- ![#ff0000](https://placehold.it/15/ff0000/000000?text=+) (**#ff0000**) `Type: Bug`: The issue is an identified bug that needs to be fixed
162+
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Type: Enhancement`: The issue is a suggestion of enhancement to your project
161163
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Type: Documentation`: The issue is the creation or refinement of a document.
162164

163165
#### Severity
164166

165-
Severity labels are mostly used for bug-related issues. It allows to identify the critical aspects of the work implied inside the issue.
167+
Severity labels are mostly used for bug-related issues. It allows to identify the critical aspects of the work implied inside the issue:
166168

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.
169+
- ![#000000](https://placehold.it/15/000000/000000?text=+) (**#000000**) `Severity: Blocker`: The issue is blocking an impending release
170+
- ![#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
171+
- ![#ff8100](https://placehold.it/15/ff8100/000000?text=+) (**#ff8100**) `Severity: High`: The issue reports incorrect functionality, bad functionality, a confusing user experience, etc
172+
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Severity: Strong`: The issue concerns changes to the core areas of the project
173+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `Severity: Medium`: The issue reports cosmetic items, formatting, spelling, colors, etc
172174
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Severity: Low`: The issue concerns a new feature or any addition to the project.
173175

174176
#### Type of change
175177

176-
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.
178+
Type of change labels are only used for pull requests. They give information about the effort needed to review a pull request:
177179

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.
180+
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Change: Minor`: Less than 64 lines changed, or less than 8 core lines changed
181+
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `Change: Medium`: Less than 256 lines changed, or less than 64 core lines changed
182+
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Change: Master`: More than 256 lines changed, or more than 64 core lines changed
181183
- ![#ff0000](https://placehold.it/15/ff0000/000000?text=+) (**#ff0000**) `Change: Expert`: Needs specialized, in-depth review.
182184

185+
*Pro Tip*: We strongly recommend to define core areas to help define the estimated effort.
186+
183187
## CHANGELOG
184188

185189
## CONTRIBUTING.md

0 commit comments

Comments
 (0)