documents "make hooks" as invoked by "make {venv,venv-mac}"

freedomofpress · Dec 2, 2021 · 0b6a60d · 0b6a60d
1 parent 1180a20
commit 0b6a60d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -69,6 +69,8 @@ make venv
 source .venv/bin/activate
 ```
 
+   * `make venv` will also run `make hooks`, which will configure Git to use the hooks found in `.githooks/` to check certain code-quality standards on new commits in this repository.  These checks are also enforced in CI.
+
 4. Run SecureDrop Client
 
 ```
@@ -104,6 +106,8 @@ make venv
 source .venv/bin/activate
 ```
 
+   * `make venv` will also run `make hooks`, which will configure Git to use the hooks found in `.githooks/` to check certain code-quality standards on new commits in this repository.  These checks are also enforced in CI.
+
 4. Run SecureDrop Client
 
 ```
@@ -151,6 +155,8 @@ It is possible to run the development environment in macOS on non-Apple Silicon
    make venv-mac
    source .venv/bin/activate
    ```
+   * `make venv-mac` will also run `make hooks`, which will configure Git to use the hooks found in `.githooks/` to check certain code-quality standards on new commits in this repository.  These checks are also enforced in CI.
+
 7. Run SecureDrop Client
    ```
    ./run.sh