Repository navigation
docs: tell contributors how to enable the shipped gitleaks pre-commit hook - #342
Merged
Merged
Conversation
… 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 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The new gitleaks install guidance omits Linux despite the shipped hook explicitly calling out Linux install guidance, leaving contributor instructions incomplete for a supported platform.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Updates contributor documentation to explain how to enable and use the repo’s shipped gitleaks pre-commit hook (.githooks/pre-commit) by setting core.hooksPath, so contributors catch secret leaks before opening PRs.
Changes:
- Add a new “Getting Started” step describing enabling the
.githookspre-commit secret scan (git config core.hooksPath .githooks). - Document installation hints for
gitleaksand thegit commit --no-verifyescape hatch. - Renumber subsequent “Getting Started” steps accordingly.
File summaries
| File | Description |
|---|---|
| CONTRIBUTING.md | Documents enabling the shipped gitleaks pre-commit hook and renumbers the onboarding steps. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…ls", comma Review feedback (repo-template#577 carries the same wording upstream). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The template upgrade shipped
.githooks/pre-commit(gitleaks secret scan), but git only runs hooks from that directory aftergit config core.hooksPath .githooks— and neither README nor CONTRIBUTING said so (repository-baseline item 4: hook present,core.hooksPathnot documented).Adds the template's Getting Started step 2 to
CONTRIBUTING.md(enable command, CLI install hint,--no-verifyescape hatch) and renumbers the following steps. Docs only; no protected files.🤖 Generated with Claude Code