From 44f82f9a8a66e624847210dff836a5ce4aa9c560 Mon Sep 17 00:00:00 2001 From: Richard Hallows Date: Tue, 12 Sep 2017 11:05:57 +0100 Subject: [PATCH] Document key deprecating rule points (#2871) * Document key deprecating rule points * Fix lint warnings * Incorporate feedback --- 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 89ac0ee0d3..e14d3d1816 100644 --- a/docs/developer-guide/rules.md +++ b/docs/developer-guide/rules.md @@ -251,6 +251,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 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 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 There's a simple way to run benchmarks on any given rule with any valid config for it: