docs: mention pre-commit in AGENTS.md and CLAUDE.md#99
Merged
Conversation
Co-authored-by: dgenio <12731907+dgenio@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add .pre-commit-config.yaml with ruff format and check hooks
docs: mention pre-commit in AGENTS.md and CLAUDE.md
Mar 4, 2026
There was a problem hiding this comment.
Pull request overview
Updates agent-facing documentation so contributors (including AI agents) install and benefit from the repo’s existing pre-commit hooks, reducing CI-only feedback for formatting/lint issues.
Changes:
- Add
pre-commit installas a top-priority “Do” item inCLAUDE.md. - Add a short post-clone note in
AGENTS.mdexplaining the ruff hooks run on commit.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
CLAUDE.md |
Adds an explicit “pre-commit install” setup step to the Claude checklist. |
AGENTS.md |
Documents running pre-commit install after cloning and what hooks run. |
You can also share your feedback on Copilot code review. Take the survey.
Align pre-commit hook descriptions with CONTRIBUTING.md by noting the standard file hygiene checks (trailing-whitespace, end-of-file-fixer, check-yaml, check-json) alongside the ruff hooks.
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 pre-commit infrastructure (
.pre-commit-config.yaml, dev dependency,CONTRIBUTING.mdsetup step) was already in place, but agent-facing guides (AGENTS.md,CLAUDE.md) had no mention of it — meaning agents and developers would skippre-commit installand only catch format/lint failures in CI.Changes
AGENTS.md— Added a note after the Commands section instructing agents to runpre-commit installonce after cloning, with a brief description of what the hooks doCLAUDE.md— Addedpre-commit installas the first "Do" item so it's the highest-priority setup step Claude seesOriginal prompt
.pre-commit-config.yamlwith ruff format + check hooks #93✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.