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
+33-68Lines changed: 33 additions & 68 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,22 +95,22 @@ Templates should promote a high contribution quality by referring [contributing
95
95
96
96
## Milestone
97
97
98
-
## Labels
98
+
## Label
99
99
100
100
### Immutablity
101
101
102
102
GitHub labels should define immutable informations about issues, in order to avoid non-updating scenarios. States should be defined in project section.
103
103
104
104
**Preferred:**
105
105
```markdown
106
-
-type
107
-
-severity
106
+
-Type: Feature
107
+
-Severity: Low
108
108
```
109
109
110
110
**Not Preferred:**
111
111
```markdown
112
-
-priority
113
-
-status
112
+
-WorkInProgress
113
+
-Critical
114
114
```
115
115
116
116
### Colors
@@ -119,44 +119,34 @@ Colors should be variants of Red-Orange-Green to provide a sense of state. It is
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.
141
137
142
138
**Preferred:**
143
139
```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
150
143
```
151
144
152
145
**Not Preferred:**
153
146
```markdown
154
-
-`Low`
155
-
-`Medium`
156
-
-`Critical`
157
-
-`Blocked`
158
-
-`Feature`
159
-
-`WorkInProgress`
147
+
- Question
148
+
- Feature
149
+
- Documentation
160
150
```
161
151
162
152
*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
165
155
166
156
Type labels should be used to define the type of task done inside the issue.
The issue is the creation or refinement of a document.
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.
161
+
- (**#c3b2ef**) `Type: Documentation`: The issue is the creation or refinement of a document.
179
162
180
163
#### Severity
181
164
182
165
Severity labels are mostly used for bug-related issues. It allows to identify the critical aspects of the work implied inside the issue.
The issue concerns a new feature or any addition to the project.
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.
172
+
- (**#c3b2ef**) `Severity: Low`: The issue concerns a new feature or any addition to the project.
201
173
202
174
#### Type of change
203
175
204
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.
- (**#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.
0 commit comments