on master help sign in
Update label management section
f9e26f6Harendra Kumar
dev/MAINTAINING.md+22−17
@@ -193,11 +193,11 @@ The level-1 triaging of the issue determines the current disposition
193of the issue. If no change is required the issue must have one of the
193of the issue. If no change is required the issue must have one of the
194following labels:
194following labels:
195
195
196−* invalid
196+* disposition:invalid
197−* question
197+* disposition:question
198−* discussion
198+* disposition:discussion
199−* duplicate
199+* disposition:duplicate
200−* wontfix
200+* disposition:wontfix
201
201
202If a change is required we need to do level-2 triage of the issue, see the
202If a change is required we need to do level-2 triage of the issue, see the
203sections below.
203sections below.
@@ -207,12 +207,13 @@ sections below.
207When a change is required we need to put one of the __change type__
207When a change is required we need to put one of the __change type__
208labels as part of level-2 triaging:
208labels as part of level-2 triaging:
209
209
210−* performance: User visible impact on performance.
210+* type:performance: User visible impact on performance.
211+* type:testing: Improves testing or related to testing.
211−* usability: It is not convenient to use the library.
212+* type:usability: It is not convenient to use the library.
212−* documentation: documentation is not correct or sufficient.
213+* type:documentation: documentation is not correct or sufficient.
213−* bug: A functionality issue, not working as expected.
214+* type:bug: A functionality issue, not working as expected.
214−* enhancement: A new feature or enhancement of the product.
215+* type:enhancement: includes a new feature or enhancement
215−* maintenance: A refactor or any other change with no user visible impact.
216+* type:maintenance: A refactor or any other change with no user visible impact.
216
217
217### Aspect
218### Aspect
218
219
@@ -229,13 +230,13 @@ default the severity is normal, if it is high we put a label:
229
230
230* severity:high
231* severity:high
231
232
232−### Change impact
233+### API impact
233
234
234For a user visible issue whether it has a release/changelog impact:
235For a user visible issue whether it has a release/changelog impact:
235
236
236−* enhancement: includes a new feature or enhancement
237+* api:new: includes a new feature or enhancement
237−* breaking: has a breaking impact on existing deployments
238+* api:breaking: has a breaking impact on existing deployments
238−* deprecating: deprecates an existing functionality
239+* api:deprecating: deprecates an existing functionality
239
240
240__RULE__: Any commit that may affect the end user in some way MUST have
241__RULE__: Any commit that may affect the end user in some way MUST have
241either a changelog entry OR MUST have an issue marked with one of the
242either a changelog entry OR MUST have an issue marked with one of the
@@ -253,9 +254,13 @@ issues:
253If the issue is assigned to someone then it is considered scheduled. Otherwise
254If the issue is assigned to someone then it is considered scheduled. Otherwise
254it is unscheduled. Unassigned issues may have the following labels:
255it is unscheduled. Unassigned issues may have the following labels:
255
256
257+* sched:deferred: deliberately deferred for some reason.
256−* deferred: blocked on any other fix or a decision to be made, or deliberately
258+* sched:blocked: blocked on any other fix or a decision to be mad
257− deferred for some reason.
259+
260+### For Contributors
261+
258* help-wanted: anyone can take the issue and contribute
262* help-wanted: anyone can take the issue and contribute
263+* good-first-issue: good for new contributors
259
264
260## Correlating Changes, Issues and Releases
265## Correlating Changes, Issues and Releases
261
266