Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document key deprecating rule points #2871

Merged
merged 3 commits into from Sep 12, 2017
Merged

Document key deprecating rule points #2871

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
880d803
Document key deprecating rule points
jeddy3 Sep 10, 2017
05177f6
Fix lint warnings
jeddy3 Sep 10, 2017
b718ca0
Incorporate feedback
jeddy3 Sep 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/developer-guide/rules.md
View file
Open in desktop
Expand Up @@ -249,6 +249,13 @@ Fixing bugs is usually very easy. Here is a process that works:

That's it! **If you are unable to figure out how to fix the bug yourself, it is still helpful to submit a pull request with your failing test cases.** It means that somebody else can jump right in and help out with the rule's logic.

## Deprecating a rule

Deprecating rules doesn't happened very often. However, these two steps are important to do:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo, happen not happened


1. Point the `stylelintReference` link to the specific version of the rule README on GitHub website, so that it is always accessible.
Copy link
Member

@ntwb ntwb Sep 10, 2017 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a the so it's on the GitHub website rather than on GitHub website

2. Add the appropriate meta data to mark the rule as deprecated.

## Improving the performance of a new or an existing rule

There's a simple way to run benchmarks on any given rule with any valid config for it:
Expand Down