Skip to content

Commit

Permalink
added pre-commit install step
Browse files Browse the repository at this point in the history
  • Loading branch information
mayank0202 committed Jan 31, 2024
1 parent cda41d3 commit 6ffe84d
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 4 deletions.
21 changes: 18 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ To ensure a smooth collaboration, please take a moment to review the following g
```
4. Make your changes and commit them.
```bash
git commit -m "Your descriptive commit message"
git commit -m "Your descriptive commit message"
```
5. Push to your forked repository.
5. Push to your forked repository.
```bash
git push origin feature/branch_name
```
Expand Down Expand Up @@ -116,6 +116,21 @@ By specifying this , it will bump the version and if you don't specify this in y
2. **Branching:**
- Follow a branching strategy (e.g., feature branches) for better collaboration.
## Pre-commit Hooks
1. **Install `pre-commit`:**
- Install `pre-commit` hooks to automatically check and enforce code formatting, linting, and other pre-defined rules before each commit.
Example:
```bash
brew install pre-commit (for mac users)
```
```bash
pre-commit run -a
```
This ensures that your code adheres to the defined standards before being committed, reducing the likelihood of introducing issues into the repository.
## Code Style
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.
Expand All @@ -136,4 +151,4 @@ GitHub Actions are in place to perform security and compliance checks. Please ma
## Licensing
By contributing, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).
By contributing, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).
2 changes: 1 addition & 1 deletion docs/module-usage-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,4 +124,4 @@ This module is licensed under the Apache 2.0 license. Refer to the [LICENSE](htt

### Open Source Contribution

Contribute to open source by using and enhancing this module. Your contributions are welcome!
Contribute to open source by using and enhancing this module. Your contributions are welcome!
4 changes: 4 additions & 0 deletions modules/alb/.terraform.lock.hcl

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions modules/health-check/.terraform.lock.hcl

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6ffe84d

Please sign in to comment.