From 316dabebf4b0060b9329e6f63b3744ae28ce7345 Mon Sep 17 00:00:00 2001 From: Chris Wolfgang Date: Thu, 17 Sep 2026 21:19:12 -0400 Subject: [PATCH 1/2] docs: tell contributors how to enable the shipped gitleaks pre-commit hook The template upgrade added .githooks/pre-commit, but git only runs it after `git config core.hooksPath .githooks`, and nothing in the repository said so. Adds the template's Getting Started step (hook, CLI install, --no-verify). Co-Authored-By: Claude Opus 5 --- CONTRIBUTING.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a90d6e45..42e8e04b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,21 +18,30 @@ You can contribute in several ways: ## Getting Started 1. **Fork the repository** and clone it locally. -2. **Create a new branch** for your feature or bug fix: +2. **Enable the pre-commit secret scan** (once per clone). The repository ships a + [gitleaks](https://github.com/gitleaks/gitleaks) hook in `.githooks/pre-commit` that blocks + commits containing credentials; CI runs the same scan, so enabling it locally only saves you a + failed PR check: + ```sh + git config core.hooksPath .githooks + ``` + Install the `gitleaks` CLI (`winget install gitleaks` / `brew install gitleaks`). Without it the + hook prints a warning and lets the commit through. `git commit --no-verify` skips it for one commit. +3. **Create a new branch** for your feature or bug fix: ```sh git checkout -b your-feature-name ``` -3. **Make your changes** and commit them with clear messages: +4. **Make your changes** and commit them with clear messages: ```sh git commit -m "Describe your changes" ``` -4. **Push your branch** to your fork: +5. **Push your branch** to your fork: ```sh git push origin your-feature-name ``` -5. **Open a pull request** describing your changes. +6. **Open a pull request** describing your changes. -6. **PR Checks:** +7. **PR Checks:** Once you create a pull request (PR), several Continuous Integration (CI) steps will run automatically. These may include: - Building the project - Running automated tests From 32bcaf4698fbfafd72c4729114329b514918b848 Mon Sep 17 00:00:00 2001 From: Chris Wolfgang Date: Thu, 17 Sep 2026 22:03:12 -0400 Subject: [PATCH 2/2] docs: secret-scan step - Linux install path, "secrets" not "credentials", comma Review feedback (repo-template#577 carries the same wording upstream). Co-Authored-By: Claude Opus 5 --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42e8e04b..a2d9c86d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,12 +20,13 @@ You can contribute in several ways: 1. **Fork the repository** and clone it locally. 2. **Enable the pre-commit secret scan** (once per clone). The repository ships a [gitleaks](https://github.com/gitleaks/gitleaks) hook in `.githooks/pre-commit` that blocks - commits containing credentials; CI runs the same scan, so enabling it locally only saves you a - failed PR check: + commits containing secrets (credentials, tokens, private keys); CI runs the same scan, so + enabling it locally only saves you a failed PR check: ```sh git config core.hooksPath .githooks ``` - Install the `gitleaks` CLI (`winget install gitleaks` / `brew install gitleaks`). Without it the + Install the `gitleaks` CLI: `winget install gitleaks` (Windows), `brew install gitleaks` (macOS), or a + binary from the [releases page](https://github.com/gitleaks/gitleaks/releases) (Linux). Without it, the hook prints a warning and lets the commit through. `git commit --no-verify` skips it for one commit. 3. **Create a new branch** for your feature or bug fix: ```sh