Linking to Rule Documentation

What happened?

You may have arrived here after clicking on a rule name from a linting error message. It was probably a rule from a plugin.

Normally, clicking on a core ESLint rule name in an error message takes you to the eslint.org page for that rule, so you can learn more about it. But the documentation for plugin rules are not on that page, so there's no simple way for us to link to them automatically. That's where you come in.

How you can help

Would you mind submitting a PR to add a link for the plugin you're using that redirected you here? That way you'll be able to click the name and get the docs quickly (like you may have just tried to do), and others will too. It really isn't hard.

GitHub Basics

First, create a fork of this repository by clicking the Fork button on the top right.

Then in a terminal, clone the newly forked repo so that you can make changes to it.

git clone https://github.com/<Your GitHub username>/linter-eslint.git
cd linter-eslint

Before making changes to the files, it's a good idea to create a feature branch.

git checkout -b <name of branch, like 'add-eslint-plugin-react-links'>

After you've made your changes (Adding rule doc links), commit them and push the branch up to GitHub.

git add <files that you want to commit>
git commit -m '<commit message, like "Add eslint-plugin-react docs links">'
git push --set-upstream origin <name of your branch, e.g. 'add-eslint-plugin-react-links'>

If you now visit your repo's GitHub page, you'll see a banner with a button to create a pull request. Click that button.

Ensure that the "base fork" is AtomLinter/linter-eslint, then give your PR a title like "Add eslint-plugin-react rule doc links", add a description if you want to provide any more details, then press the big green "Create pull request" button.

Congrats! You've done humanity a small service. A team member of linter-eslint will review your changes and merge them into the main repository. Once a new version is released with your changes, everyone will be able to click that plugin's rule names and be taken to the correct documentation page to learn more about it.

Adding rule doc links

[To be added...]