Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 3.24 KB

issues.md

File metadata and controls

94 lines (59 loc) · 3.24 KB
Raw

Managing issues

We manage issues consistently for the benefit of ourselves and our users.

Labels

Use labels.

When you first triage an issue, you should:

  • add one of the status: needs * labels, e.g. status: needs discussion
  • don't add any other label

After triage, you should add:

  • one of the non-need status: * labels, e.g. status: ready to implement
  • zero or one of the type: * labels, e.g. type: new rule
  • zero, one or more of the syntax: * labels, e.g. syntax: scss
  • optionally, the good first issue, help wanted, priority: high and upstream labels

Milestones

Use milestones.

You should:

  • use the future-major milestone for issues that introduce breaking changes
  • optionally, create version milestones (e.g. 8.x) to manage upcoming releases

Titles

Rename the title into a consistent format.

You should:

  • lead with the CHANGELOG group names, but in the present tense:
    • "Remove y", e.g. "Remove unit-disallowed-list"
    • "Deprecate x in y", e.g. "Deprecate resolvedNested option in selector-class-pattern"
    • "Add y", e.g. "Add unit-disallowed-list"
    • "Add x to y", e.g. "Add ignoreProperties: [] to property-disallowed-list"
    • "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"

Saved replies

You should use saved replies.

Close an issue

That doesn't use a template:

Thank you for creating this issue. However, issues need to follow one of our templates so that we can clearly understand your particular circumstances.

Please help us help you by [recreating the issue](https://github.com/stylelint/stylelint/issues/new/choose) using one of our templates.

That is best-suited as a plugin:

Thank you for your suggestion. I think this is best-suited as a [plugin](https://stylelint.io/developer-guide/plugins).

Label as ready to implement

That fixes a bug in a rule:

I've labeled the issue as ready to implement. Please consider [contributing](https://stylelint.io/contributing) if you have time.

There are [steps on how to fix a bug in a rule](https://stylelint.io/developer-guide/rules#fix-a-bug-in-a-rule) in the Developer guide.

That adds a new option to a rule:

I've labeled the issue as ready to implement. Please consider [contributing](https://stylelint.io/contributing) if you have time.

There are [steps on how to add a new option](https://stylelint.io/developer-guide/rules#add-an-option-to-a-rule) in the Developer guide.

That adds a new rule:

I've labeled the issue as ready to implement. Please consider [contributing](https://stylelint.io/contributing) if you have time.

There are [steps on how to add a new rule](https://stylelint.io/developer-guide/rules#add-a-rule) in the Developer guide.

That is another type of improvement:

I've labeled the issue as ready to implement. Please consider [contributing](https://stylelint.io/contributing) if you have time.