Skip to content

Commit 6ffe84d

Browse files
author
mayank0202
committed
added pre-commit install step
1 parent cda41d3 commit 6ffe84d

File tree

4 files changed

+24
-4
lines changed

4 files changed

+24
-4
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ To ensure a smooth collaboration, please take a moment to review the following g
1616
```
1717
4. Make your changes and commit them.
1818
```bash
19-
git commit -m "Your descriptive commit message"
19+
git commit -m "Your descriptive commit message"
2020
```
21-
5. Push to your forked repository.
21+
5. Push to your forked repository.
2222
```bash
2323
git push origin feature/branch_name
2424
```
@@ -116,6 +116,21 @@ By specifying this , it will bump the version and if you don't specify this in y
116116
2. **Branching:**
117117
- Follow a branching strategy (e.g., feature branches) for better collaboration.
118118
119+
## Pre-commit Hooks
120+
121+
1. **Install `pre-commit`:**
122+
- Install `pre-commit` hooks to automatically check and enforce code formatting, linting, and other pre-defined rules before each commit.
123+
124+
Example:
125+
```bash
126+
brew install pre-commit (for mac users)
127+
```
128+
```bash
129+
pre-commit run -a
130+
```
131+
132+
This ensures that your code adheres to the defined standards before being committed, reducing the likelihood of introducing issues into the repository.
133+
119134
## Code Style
120135
121136
Please follow the Terraform language conventions and formatting guidelines. Consider using an editor with Terraform support or a linter to ensure adherence to the style.
@@ -136,4 +151,4 @@ GitHub Actions are in place to perform security and compliance checks. Please ma
136151
137152
## Licensing
138153
139-
By contributing, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).
154+
By contributing, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).

docs/module-usage-guide/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ This module is licensed under the Apache 2.0 license. Refer to the [LICENSE](htt
124124

125125
### Open Source Contribution
126126

127-
Contribute to open source by using and enhancing this module. Your contributions are welcome!
127+
Contribute to open source by using and enhancing this module. Your contributions are welcome!

modules/alb/.terraform.lock.hcl

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

modules/health-check/.terraform.lock.hcl

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)