From c9cec6ff8969e26147235d3ee28666857c080ecd Mon Sep 17 00:00:00 2001 From: MaxymVlasov Date: Mon, 17 Feb 2025 22:25:04 +0200 Subject: [PATCH 1/2] docs: Describe succinctly what the software does (what problem does it solve?) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 789d8da92..5b1fe92be 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ [![StandWithUkraine Banner]](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) +`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. + Want to contribute? Check [open issues](https://github.com/antonbabenko/pre-commit-terraform/issues?q=label%3A%22good+first+issue%22+is%3Aopen+sort%3Aupdated-desc) and [contributing notes](/.github/CONTRIBUTING.md). From e3b67cc0b94e4956055dbc71947d643802fdd1f6 Mon Sep 17 00:00:00 2001 From: Maksym Vlasov Date: Tue, 18 Feb 2025 01:51:27 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: George L. Yermulnik --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5b1fe92be..f5a601a23 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,12 @@ [![StandWithUkraine Banner]](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) -`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. +[`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. + +It can be run: +* Locally and in CI +* As standalone Git hooks or as a Docker image +* For the entire repository or just for change-related files (e.g., local git stash, last commit, or all changes in a Pull Request) Want to contribute? Check [open issues](https://github.com/antonbabenko/pre-commit-terraform/issues?q=label%3A%22good+first+issue%22+is%3Aopen+sort%3Aupdated-desc)