2.6 KiB
2.6 KiB
Managing issues
You should:
- use labels and:
- add one of the
status: *labels (or thehelp wantedlabel when ready-to-go) - add zero or one of the
type: *labels - add zero, one or more of the
non-standard syntax: *labels - optionally, add the
good first issuelabel
- add one of the
- rename the title into a consistent format and:
- lead with the CHANGELOG group names, but in the present tense:
- "Remove y" e.g. "Remove unit-blacklist"
- "Deprecate x in y" e.g. "Deprecate resolvedNested option in selector-class-pattern"
- "Add y" e.g. "Add unit-blacklist"
- "Add x to y" e.g. "Add ignoreProperties: [] to property-blacklist"
- "Fix false positives/negatives for x in y" e.g. "Fix false positives for Less mixins in color-no-hex"
- use
*if the issue applies to a group of rules e.g. "Fix false negatives for SCSS variables in selector-*-pattern"
- lead with the CHANGELOG group names, but in the present tense:
- provide a link to the relevant section of the Developer Guide when:
- adding the
help wantedlabel to encourage the original poster to contribute, e.g. adding an option to an existing rule or fixing a bug in an existing rule - closing an issue because the feature is best part of ecosystem e.g. a plugin or processor
- adding the
- use milestones only on issues and not on pull requests and:
- use the
future-majormilestone for issues that introduce breaking changes - optionally, create version milestones (e.g.
8.x) to manage upcoming releases
- use the
- use the following saved reply to close any issue that do not use the template:
Thanks for creating this issue but we're closing it as issues need to follow one of our templates, so that we can clearly understand your particular circumstances.
Please help us to help you by [recreating the issue](https://github.com/stylelint/stylelint/issues/new/choose) using one of our templates.
There are three rules of thumb. You should use the:
status: discussion,status: needs clarificationorstatus: needs investigationlabel when first triaging an issuehelp wanted, atype(andnon-standard syntax: *andgood first issue) labels when a course of action is agreedstatus: wiplabel when your are, or someone has said they are, about to start working on an issue