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
+20-16Lines changed: 20 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,6 +97,8 @@ Templates should promote a high contribution quality by referring [contributing
97
97
98
98
## Label
99
99
100
+
Labels should help contributors and reviewers to evaluate effort for a specific issue or pull request.
101
+
100
102
### Immutablity
101
103
102
104
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
115
117
116
118
### Colors
117
119
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.
119
121
120
122
**Preferred:**
121
123
@@ -133,7 +135,7 @@ It is better to use similar color styling accross categories for a consistent an
133
135
134
136
### Categories
135
137
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.
137
139
138
140
**Preferred:**
139
141
```markdown
@@ -153,33 +155,35 @@ Labels should help reviewers to quickly get information about the reviewing effo
153
155
154
156
#### Type
155
157
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:
157
159
158
-
- (**#00cc41**) `Type: Feature`: The issue is the development of a new feature of your project.
159
-
- (**#ff0000**) `Type: Bug`: The issue is an identified bug that needs to be fixed.
160
-
- (**#ffe700**) `Type: Enhancement`: The issue is a suggestion of enhancement to your project.
160
+
- (**#00cc41**) `Type: Feature`: The issue is the development of a new feature of your project
161
+
- (**#ff0000**) `Type: Bug`: The issue is an identified bug that needs to be fixed
162
+
- (**#ffe700**) `Type: Enhancement`: The issue is a suggestion of enhancement to your project
161
163
- (**#c3b2ef**) `Type: Documentation`: The issue is the creation or refinement of a document.
162
164
163
165
#### Severity
164
166
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:
166
168
167
-
- (**#000000**) `Severity: Blocker`: The issue is blocking an impending release.
168
-
- (**#ff4000**) `Severity: Critical`: The issue causes data loss, crashes or hangs salt processes, makes the system unresponsive, etc.
169
-
- (**#ff8100**) `Severity: High`: The issue reports incorrect functionality, bad functionality, a confusing user experience, etc.
170
-
- (**#ffe700**) `Severity: Strong`: The issue concerns changes to the core areas of the project.
171
-
- (**#00cc41**) `Severity: Medium`: The issue reports cosmetic items, formatting, spelling, colors, etc.
169
+
- (**#000000**) `Severity: Blocker`: The issue is blocking an impending release
170
+
- (**#ff4000**) `Severity: Critical`: The issue causes data loss, crashes or hangs salt processes, makes the system unresponsive, etc
171
+
- (**#ff8100**) `Severity: High`: The issue reports incorrect functionality, bad functionality, a confusing user experience, etc
172
+
- (**#ffe700**) `Severity: Strong`: The issue concerns changes to the core areas of the project
- (**#c3b2ef**) `Severity: Low`: The issue concerns a new feature or any addition to the project.
173
175
174
176
#### Type of change
175
177
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:
177
179
178
-
- (**#c3b2ef**) `Change: Minor`: Less than 64 lines changed, or less than 8 core lines changed.
179
-
- (**#00cc41**) `Change: Medium`: Less than 256 lines changed, or less than 64 core lines changed.
180
-
- (**#ffe700**) `Change: Master`: More than 256 lines changed, or more than 64 core lines changed.
180
+
- (**#c3b2ef**) `Change: Minor`: Less than 64 lines changed, or less than 8 core lines changed
181
+
- (**#00cc41**) `Change: Medium`: Less than 256 lines changed, or less than 64 core lines changed
182
+
- (**#ffe700**) `Change: Master`: More than 256 lines changed, or more than 64 core lines changed
0 commit comments