Skip to content

Clarify that files modified in prek runs are still failures #1580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 3 commits into from
Mar 27, 2026
Merged

Clarify that files modified in prek runs are still failures #1580

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
789baea
Initial plan
Copilot Mar 27, 2026
d14b439
Clarify that 'Files were modified by following hooks' is a prek failure
Copilot Mar 27, 2026
7c57077
Merge branch 'main' into copilot/update-agent-skills-static-checks
nathanjmcdougall Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .agents/skills/usethis-qa-static-checks/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Perform static code checks
compatibility: usethis, Python, prek, basedpyright
license: MIT
metadata:
version: "1.5"
version: "1.6"
---

# Static Checks
Expand All @@ -24,4 +24,6 @@ Before submitting changes for review, **always** run these static checks. This s

## What to do when prek checks fail

**Important:** A prek run is a failure if it reports `Files were modified by following hooks`, even if every individual hook shows "Passed" or "Skipped". File modifications by hooks (e.g. auto-formatting by Ruff or prettier) count as a failure because the working tree was changed. You must re-run prek after such modifications to confirm a clean pass.

It's quite common for minor cosmetic changes to be made automatically when running the prek checks, even by linters such as Ruff and mkdownlint-cli2. Since auto-fixes may have been applied during the first run, if checks fail, you should re-run a second time to see if any issues remain. Only then should you proceed to fix any remaining issues manually.