Skip to content

Latest commit

 

History

History
12 lines (9 loc) · 454 Bytes

rule-documentation-template.md

File metadata and controls

12 lines (9 loc) · 454 Bytes

Rule: The headline contains the rule title

Background

A paragraph that briefly describes the context of the rule.

Reasoning

Explanation why the rule has been created. The reader should understand the reasons.

How it works

Technical details, what exactly is checked. This may help determine false positives.

How to fix

Description how to resolve a found violation. Should contain example code and explain why it is a better alternative.