From 880d8036e15bec6ae4dcf00645aacaef7d76efa5 Mon Sep 17 00:00:00 2001 From: jeddy3 Date: Sun, 10 Sep 2017 08:52:13 +0100 Subject: [PATCH 1/3] Document key deprecating rule points --- docs/developer-guide/rules.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/developer-guide/rules.md b/docs/developer-guide/rules.md index c2d2e7ee9a..e23758b05c 100644 --- a/docs/developer-guide/rules.md +++ b/docs/developer-guide/rules.md @@ -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: + +1. Point the `stylelintReference` link to the specific version of the rule README on GitHub website, so that it is always accessible. +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: From 05177f6ef004375050abf8f61093af0aa60d9d5d Mon Sep 17 00:00:00 2001 From: jeddy3 Date: Sun, 10 Sep 2017 11:51:07 +0100 Subject: [PATCH 2/3] Fix lint warnings --- docs/developer-guide/rules.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide/rules.md b/docs/developer-guide/rules.md index e23758b05c..b9fbe8a2df 100644 --- a/docs/developer-guide/rules.md +++ b/docs/developer-guide/rules.md @@ -253,8 +253,8 @@ That's it! **If you are unable to figure out how to fix the bug yourself, it is Deprecating rules doesn't happened very often. However, these two steps are important to do: -1. Point the `stylelintReference` link to the specific version of the rule README on GitHub website, so that it is always accessible. -2. Add the appropriate meta data to mark the rule as deprecated. +1. Point the `stylelintReference` link to the specific version of the rule README on GitHub website, so that it is always accessible. +2. Add the appropriate meta data to mark the rule as deprecated. ## Improving the performance of a new or an existing rule From b718ca0efc44bede2dfcdcadc15c6e2510f1cc91 Mon Sep 17 00:00:00 2001 From: jeddy3 Date: Sun, 10 Sep 2017 12:25:04 +0100 Subject: [PATCH 3/3] Incorporate feedback --- docs/developer-guide/rules.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide/rules.md b/docs/developer-guide/rules.md index b9fbe8a2df..be83ac0ade 100644 --- a/docs/developer-guide/rules.md +++ b/docs/developer-guide/rules.md @@ -251,9 +251,9 @@ That's it! **If you are unable to figure out how to fix the bug yourself, it is ## Deprecating a rule -Deprecating rules doesn't happened very often. However, these two steps are important to do: +Deprecating rules doesn't happen very often. However, these two steps are important to do: -1. Point the `stylelintReference` link to the specific version of the rule README on GitHub website, so that it is always accessible. +1. Point the `stylelintReference` link to the specific version of the rule README on the GitHub website, so that it is always accessible. 2. Add the appropriate meta data to mark the rule as deprecated. ## Improving the performance of a new or an existing rule