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.
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
Document key deprecating rule points #2871
Conversation
Oops, fixed the lint warnings. This is ready for review now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A spelling typo fix please 😏
docs/developer-guide/rules.md
Outdated
@@ -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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo, happen
not happened
docs/developer-guide/rules.md
Outdated
|
||
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. |
There was a problem hiding this comment.
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
@ntwb Thanks for the feedback... silly typos from writing docs in the wee hours :) |
@ntwb Amends incorporated. Ready for review again. |
Closes #2804
Closes #2622
Documenting this so that we can close the above two issues.