.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / stylelint / docs / developer-guide / issues.md
1 # Managing issues
2
3 -   Use [labels](https://github.com/stylelint/stylelint/labels):
4     -   Add _one_ of the `status: *` labels (or the `help wanted` label when ready-to-go).
5     -   Add _zero or one_ of the `type: *` labels.
6     -   Add _zero, one or more_ of the `non-standard syntax: *` labels.
7     -   Optionally, add the `good first issue` label.
8 -   Rename the title into a consistent format:
9     -   Lead with the [CHANGELOG group names](pull-requests.md), but in the present tense:
10         -   "Remove y" e.g. "Remove unit-blacklist".
11         -   "Deprecate x in y" e.g. "Deprecate resolvedNested option in selector-class-pattern".
12         -   "Add y" e.g. "Add unit-blacklist".
13         -   "Add x to y" e.g. "Add ignoreProperties: [] to property-blacklist".
14         -   "Fix false positives/negatives for x in y" e.g. "Fix false positives for Less mixins in color-no-hex".
15     -   Use `*` if the issue applies to a group of rules e.g. "Fix false negatives for SCSS variables in selector-*-pattern"
16 -   Provide a link to the relevant section of the [Developer Guide](../developer-guide.md) when:
17     -   Adding the `help wanted` label to encourage the original poster to contribute., e.g. [adding an option to an existing rule](../developer-guide/rules.md#adding-an-option-to-an-existing-rule) or [fixing a bug in an existing rule](../developer-guide/rules.md#fixing-a-bug-in-an-existing-rule).
18     -   Closing an issue because the feature is best part of ecosystem e.g. [a plugin](https://github.com/stylelint/stylelint/blob/master/docs/developer-guide/plugins.md) or [processor](https://github.com/stylelint/stylelint/blob/master/docs/developer-guide/processors.md).
19 -   Use milestones only on issues and not on pull requests:
20     -   Use the `future-major` milestone for issues that introduce breaking changes.
21     -   Optionally, create version milestones (e.g. `8.x`) to manage upcoming releases.
22 -   Use the following saved reply to close any issue that do not use the template:
23
24 ```md
25 Thanks for creating this issue but we are closing it as issues need to follow our issue template, so that we can clearly understand your particular circumstances.
26
27 Please help us to help you by [recreating the issue](https://github.com/stylelint/stylelint/issues/new) using the template.
28 ```
29
30 General rules of thumb:
31
32 -   Use the `status: discussion`, `status: needs clarification` or `status: needs investigation` label when first triaging an issue.
33 -   Use the `help wanted`, a `type` (and `non-standard syntax: *` and `good first issue`) labels when a course of action is agreed.
34 -   Use the `status: wip` label when your are, or someone has said they are, about to start working on an issue.