You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ A comprehensive suite of Git hooks and development environment setup tools that
14
14
15
15
16
16
17
-
## Overview
17
+
## Overview
18
18
This toolkit provides automated setup and enforcement of development best practices through:
19
19
20
20
- Code formatting and linting
@@ -27,18 +27,18 @@ This toolkit provides automated setup and enforcement of development best practi
27
27
-**MacOS:** Above Mac OS X 10.7 Lion
28
28
29
29
## Prerequisites
30
-
-```sudo``` may be required depending on your system configuration
30
+
-```sudo``` may be required depending on your system configuration
31
31
- git (version control)
32
32
## Installation Tools
33
33
The following tools will be automatically installed during setup:
34
34
35
35
- asdf (version manager)
36
-
- Node.js
37
-
- python
36
+
- Node.js
37
+
- python
38
38
- typescript
39
39
- black 23.9.1
40
40
- Golang
41
-
- terraform
41
+
- terraform
42
42
- tflint 0.39.2
43
43
- tfsec 1.28.1
44
44
- terraform-docs 0.16.0
@@ -66,19 +66,19 @@ chmod +x precommit-startup.sh
66
66
```
67
67
4. Choose the pre-commit hooks you want to install:
68
68
```
69
-
[1] Global pre-commit hooks
69
+
[1] Global pre-commit hooks
70
70
[2] Golang pre-commit hooks
71
71
[3] Python pre-commit hooks
72
72
[4] Terraform pre-commit hooks
73
73
[5] TypeScript pre-commit hooks
74
74
[6] Exit
75
75
```
76
76
5. Ensure that you provide the correct version of [nodejs/golang/python/terraform] instead of "latest" before proceeding.
77
-
6. After installation, the githooks template will be set up globally for all repositories.
77
+
6. After installation, the githooks template will be set up globally for all repositories.
78
78
79
-
7. Note that the setup is only required for new repositories. Existing repositories will not automatically adopt these hooks. To set up the hooks for an existing repository:
79
+
7. Note that the setup is only required for new repositories. Existing repositories will not automatically adopt these hooks. To set up the hooks for an existing repository:
80
80
- You will need to manually reinitialize the repository with `git init` to apply the template.
81
-
81
+
82
82
OR
83
83
84
84
- Clone the existing repository to your local machine again to adopt the hooks automatically.
@@ -89,7 +89,7 @@ chmod +x precommit-startup.sh
89
89
90
90
## Skipping Pre-commit Hooks
91
91
92
-
To ignore specific pre-commit hooks for a specific file, you can modify the .pre-commit-config.yaml file by adding an `exclude` pattern under the specific hook configuration.
92
+
To ignore specific pre-commit hooks for a specific file, you can modify the .pre-commit-config.yaml file by adding an `exclude` pattern under the specific hook configuration.
93
93
94
94
For example, to exclude the main.yaml file from the check-yaml hook, add the following line to the .pre-commit-config.yaml file:
95
95
@@ -103,11 +103,11 @@ repos:
103
103
- id: check-yaml
104
104
exclude: ^main\.yaml$
105
105
```
106
-
106
+
107
107
108
108
109
109
b. Exclude multiple files (main.yaml and config.yaml are excluded)
We embrace an open and inclusive community philosophy. Motivated contributors are encouraged to join the [maintainers' team](docs/content/contributing/maintainers.md).
145
+
We embrace an open and inclusive community philosophy. Motivated contributors are encouraged to join the [maintainers' team](docs/content/contributing/maintainers.md).
146
146
Learn more about pull request reviews and issue triaging in our [maintainers guide](docs/content/contributing/maintainers-guidelines.md).
147
147
148
148
## Contributing
149
-
Interested in contributing? Refer to our [contributing documentation](CONTRIBUTING.md).
149
+
Interested in contributing? Refer to our [contributing documentation](CONTRIBUTING.md).
150
150
This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md), and participation requires compliance with its terms.
0 commit comments