# Contributing guidelines

## I have an idea for a new rule

Open an issue with your proposal. Make sure you elaborate on what problem it solves, explain why the rule should exist, and include fail/pass examples.

Rule documentation must include a succinct rationale that explains why the rule exists, not only what syntax it reports.

<!--
## I have an idea for a new rule and I also want to implement it

First open an issue with your proposal. When the rule is accepted, see the [docs on creating and submitting a new rule](../docs/new-rule.md).

## I want to implement a rule from an open issue

See the [docs on creating and submitting a new rule](../docs/new-rule.md).

## How to write tests

See the [docs on writing tests](../docs/write-tests.md).
-->