Add pre-commit hooks guidance to CONTRIBUTING.md#1388
Open
palas wants to merge 2 commits into
Open
Conversation
palas
requested review from
Jimbo4350,
carbolymer,
disassembler,
kevinhammond and
newhoggy
as code owners
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation describing how this repository’s Nix-provided pre-commit hooks behave (and how to work around common failures when not in the Nix dev shell), alongside the required changelog fragment.
Changes:
- Documented pre-commit hook requirements and common workarounds in
CONTRIBUTING.md. - Added a
.changes/documentation fragment for the update.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds a new “Pre-commit hooks” section explaining the Nix shell dependency and suggested workarounds. |
| .changes/20260602_013028_cardano-cli_pablo.lamela_document_commit_hook_issues.yml | Changelog fragment recording the documentation update. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
carbolymer
reviewed
Jun 2, 2026
| For packages that we do not control, we can end up in a situation where we have a fork that looks like it will be long-lived or permanent (e.g. the maintainer is unresponsive, or the change has been merged but not released). | ||
| In that case, release a patched version to the [CHaP repository][CHaP], which allows us to remove the `source-repository-package` stanza. | ||
|
|
||
| ## Pre-commit hooks |
Contributor
There was a problem hiding this comment.
Suggestion: use one sentence per line. Would be more diff friendly.
carbolymer
approved these changes
Jun 2, 2026
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.
Context
Contributors working outside of the Nix development shell encounter confusing failures from pre-commit hooks (e.g.
cabal-gildnot found). This documents the requirement and common workarounds.How to trust this PR
Documentation-only change to
CONTRIBUTING.md. No code changes.Review the diff — it adds a new "Pre-commit hooks" section covering:
--no-verifyfor WIP commitsChecklist
.changes/