Documentation for Rules

[MeirionHughes]

• Add .md files for rules, under ./doc/rules

should have:

• title
• issues reported
  • details about the issue and consequences
  • short example

[atsu85]

I'm wondering, whether the examples should eventually be embedded from actual tests? That can't be done on github repo markdown pages, but it could be done in html (and could be hosted in github pages).

[MeirionHughes]

Could do. I'll admin this isn't something high on my priority at the moment, given the whole project will be seeing changes for a while.

[atsu85]

I agree, that's why i mentioned

eventually

as i understand it needs some effort

[MeirionHughes]

I've put an optional url field on the issues btw, so they can link to something. obviously not all that useful within a gulp task. :D