Skip to content

Commit 6d17191

Browse files
authored
Add contributing guidelines
#240 (comment)
1 parent a94f27e commit 6d17191

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
## Accepted Rules
4+
5+
Terraform Language rules implement recommendations from the [Terraform Language documentation](https://www.terraform.io/language). This ruleset _does not_ provide configurable rules for personal/team style or usage preferences. If you'd like to enforce stylistic rules beyond the official Terraform Language recommendations, you should [author your own ruleset plugin](https://github.com/terraform-linters/tflint/blob/master/docs/developer-guide/plugins.md).
6+
7+
In rare circumstances, we may also accept rules that detect language usage errors that are _not_ already detected by `terraform validate`.
8+
9+
If you are unsure whether your proposed rule meets these criteria, [open a discussion](https://github.com/terraform-linters/tflint-ruleset-terraform/discussions/new?category=ideas) thread first before authoring a pull request.
10+
11+
## Authoring a Rule
12+
13+
Each rule should have:
14+
15+
* A source file implementing the rule
16+
* Tests that check expected issues against different Terraform configurations to cover applicable cases
17+
* Documentation explaining the rule, its motivation, and how users should fix their configuration
18+
19+
You will also need to add your rule to applicable [presets](https://github.com/terraform-linters/tflint-ruleset-terraform/blob/main/rules/preset.go).

0 commit comments

Comments
 (0)