Suggestion: Per-Rule metadata

julianbartel commented 5 years ago

Proposal is to have additional metadata on a per rule basis. This could be achieved by moving every rule into its own markdown file so it has its own front matter. Use case examples:

references to static code analysis tools covering the rule
additional rules for other languages (eg. C++), where the majority of rules ist shared across languages - with the language specified in the rule, a developer can filter for rules applying to his language.
the same as above but for team specific rules.

The problem I see is that this would be an absolutely breaking change. However, I have a working prototype and could provide a PR if you are interested.

dennisdoomen commented 5 years ago

I'm actually quite interested in that. I've been considering the same thing. It would also make everything more searchable (potentially).

julianbartel commented 5 years ago

Created PR #196 but marked as draft as I would like to discuss a few points (provided in PR comment).

julianbartel commented 4 years ago

Now that this has been done, the issue can be closed. @dennisdoomen Thanks for your support and accepting PR #196.

dennisdoomen commented 4 years ago

Thank you for this awesome contribution. It made the site so much better.

dennisdoomen / CSharpGuidelines

Suggestion: Per-Rule metadata #195