Skip to content

Commit 8a38366

Browse files
docs: Describe succinctly what the software does (what problem does it solve?) (#820)
--------- Co-authored-by: George L. Yermulnik <[email protected]>
1 parent c613da7 commit 8a38366

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@
99

1010
[![StandWithUkraine Banner]](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
1111

12+
[`pre-commit-terraform`](https://github.com/antonbabenko/pre-commit-terraform) provides a collection of [Git Hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) for Terraform and related tools and is driven by the [pre-commit framework](https://pre-commit.com). It helps ensure that Terraform, OpenTofu, and Terragrunt configurations are kept in good shape by automatically running various checks and formatting code before committing changes to version control system. This helps maintain code quality and consistency across the project.
13+
14+
It can be run:
15+
* Locally and in CI
16+
* As standalone Git hooks or as a Docker image
17+
* For the entire repository or just for change-related files (e.g., local git stash, last commit, or all changes in a Pull Request)
18+
1219
Want to contribute?
1320
Check [open issues](https://github.com/antonbabenko/pre-commit-terraform/issues?q=label%3A%22good+first+issue%22+is%3Aopen+sort%3Aupdated-desc)
1421
and [contributing notes](/.github/CONTRIBUTING.md).

0 commit comments

Comments
 (0)