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.

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

Merged
merged 3 commits into from Sep 12, 2017
Merged

Document key deprecating rule points #2871

merged 3 commits into from Sep 12, 2017

Conversation

jeddy3
Copy link
Member

@jeddy3 jeddy3 commented Sep 10, 2017

Closes #2804
Closes #2622

Documenting this so that we can close the above two issues.

@jeddy3
Copy link
Member Author

jeddy3 commented Sep 10, 2017

Oops, fixed the lint warnings. This is ready for review now.

Copy link
Member

@ntwb ntwb left a 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 😏

@@ -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


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.
Copy link
Member

@ntwb ntwb Sep 10, 2017

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

@jeddy3
Copy link
Member Author

jeddy3 commented Sep 10, 2017

@ntwb Thanks for the feedback... silly typos from writing docs in the wee hours :)

@jeddy3
Copy link
Member Author

jeddy3 commented Sep 12, 2017

@ntwb Amends incorporated. Ready for review again.

@ntwb ntwb merged commit 44f82f9 into master Sep 12, 2017
@ntwb ntwb deleted the dev-guide-deprecating branch September 12, 2017 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Broken deprecation links Add rules metadata to include if it's deprecated or not
3 participants