Proposal: Add WIP rule documentation style guide to repo

Currently rule documentation style guide is being discussed in a myriad of issues, and it’s getting difficult to see the wood for the trees.

Is it OK to add a WIP document to the repo, so that we can track changes to it, discuss changes in PRs, etc?

The document would be limited scope: rule documentation.

Cons:

• An unfinished document, with non-stable guidance in repo
  • Mitigate by filename (eg. _style-guide(WIP).md and h1 message at start of doc?

Pros:

• All style guide discussions focus on one tracked file
• Bikeshedding leads to tangible results in the file
• It’s easier to discuss and iterate something that exists, than something that doesn’t
• Whilst maintaining docs, if we spot an issue, we can update the guide as part of our workflow

cc: @pedrottimark @scriptdaemon @ilyavolodin

[ilyavolodin]

@pedrottimark I think Rule Documentation Template is probably the best place to start. I would go with maximum template, noting which parts are optional. @aubergine10 plan sounds good.

[pedrottimark]

Here are the current rules that apply when Validating Markdown Files

https://github.com/eslint/eslint/blob/master/Makefile.js#L329-L358