Skip to content

Commit e3b67cc

Browse files
Apply suggestions from code review
Co-authored-by: George L. Yermulnik <[email protected]>
1 parent c9cec6f commit e3b67cc

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@
99

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

12-
`pre-commit-terraform` provides a collection of git hooks for Terraform and related tools to be used with 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 checks and formatting code before commits, and you can run these checks in CI too. This helps maintain code quality and consistency across the project.
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)
1318

1419
Want to contribute?
1520
Check [open issues](https://github.com/antonbabenko/pre-commit-terraform/issues?q=label%3A%22good+first+issue%22+is%3Aopen+sort%3Aupdated-desc)

0 commit comments

Comments
 (0)