on master help sign in
Update label management section

With prefixes for different categories of labels.

commitf9e26f64b7a9a7da1ad1ef1aacf64927e0201442 authorHarendra Kumar <harendra@composewell.com> dateTue 23 Nov 2021, 23:12 (5 years ago) parent8a53a3f
1 file changed+22−17
dev/MAINTAINING.md+22−17
dev/MAINTAINING.md+22−17
@@ -193,11 +193,11 @@ The level-1 triaging of the issue determines the current disposition
193193of the issue. If no change is required the issue must have one of the
194194following labels:
195195
196−* invalid
197−* question
198−* discussion
199−* duplicate
200−* wontfix
196+* disposition:invalid
197+* disposition:question
198+* disposition:discussion
199+* disposition:duplicate
200+* disposition:wontfix
201201
202202If a change is required we need to do level-2 triage of the issue, see the
203203sections below.
@@ -207,12 +207,13 @@ sections below.
207207When a change is required we need to put one of the __change type__
208208labels as part of level-2 triaging:
209209
210−* performance: User visible impact on performance.
211−* usability: It is not convenient to use the library.
212−* documentation: documentation is not correct or sufficient.
213−* bug: A functionality issue, not working as expected.
214−* enhancement: A new feature or enhancement of the product.
215−* maintenance: A refactor or any other change with no user visible impact.
210+* type:performance: User visible impact on performance.
211+* type:testing: Improves testing or related to testing.
212+* type:usability: It is not convenient to use the library.
213+* type:documentation: documentation is not correct or sufficient.
214+* type:bug: A functionality issue, not working as expected.
215+* type:enhancement: includes a new feature or enhancement
216+* type:maintenance: A refactor or any other change with no user visible impact.
216217
217218### Aspect
218219
@@ -229,13 +230,13 @@ default the severity is normal, if it is high we put a label:
229230
230231* severity:high
231232
232−### Change impact
233+### API impact
233234
234235For a user visible issue whether it has a release/changelog impact:
235236
236−* enhancement: includes a new feature or enhancement
237−* breaking: has a breaking impact on existing deployments
238−* deprecating: deprecates an existing functionality
237+* api:new: includes a new feature or enhancement
238+* api:breaking: has a breaking impact on existing deployments
239+* api:deprecating: deprecates an existing functionality
239240
240241__RULE__: Any commit that may affect the end user in some way MUST have
241242either a changelog entry OR MUST have an issue marked with one of the
@@ -253,9 +254,13 @@ issues:
253254If the issue is assigned to someone then it is considered scheduled. Otherwise
254255it is unscheduled. Unassigned issues may have the following labels:
255256
256−* deferred: blocked on any other fix or a decision to be made, or deliberately
257− deferred for some reason.
257+* sched:deferred: deliberately deferred for some reason.
258+* sched:blocked: blocked on any other fix or a decision to be mad
259+
260+### For Contributors
261+
258262* help-wanted: anyone can take the issue and contribute
263+* good-first-issue: good for new contributors
259264
260265## Correlating Changes, Issues and Releases
261266