Skip to content

Commit d069280

Browse files
update readme to include precommit install (#1242)
* update readme to include precommit install * add mac install instructions * add gitleaks to default install * remove unneeded params * edit readme * include compliance blurb * whitespace --------- Co-authored-by: Sean Fern <[email protected]>
1 parent e938383 commit d069280

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
1. [Create volume directory](#create-volume-directory)
1313
1. [Running Locally with Intelij](#running-locally-with-intelij)
14+
1. [Installing and Using Pre-Commit](#installing-and-using-pre-commit)
1415

1516
## Create volume directory
1617

@@ -50,3 +51,27 @@ API Setup
5051

5152

5253
[AB2D Deploy](Deploy/README.md)
54+
55+
## Installing and Using Pre-commit
56+
57+
Anyone committing to this repo must use the pre-commit hook to lower the likelihood that secrets will be exposed.
58+
59+
### Step 1: Install pre-commit
60+
61+
You can install pre-commit using the MacOS package manager Homebrew:
62+
63+
```sh
64+
brew install pre-commit
65+
```
66+
67+
Other installation options can be found in the [pre-commit documentation](https://pre-commit.com/#install).
68+
69+
### Step 2: Install the hooks
70+
71+
Run the following command to install the gitleaks hook:
72+
73+
```sh
74+
pre-commit install
75+
```
76+
77+
This will download and install the pre-commit hooks specified in `.pre-commit-config.yaml`.

0 commit comments

Comments
 (0)