Skip to content

Emphasize static checks are required for all changes, including doc-only #1669

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 2 commits into from
Mar 31, 2026
+6 −4
Merged

Emphasize static checks are required for all changes, including doc-only #1669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
887851b
Initial plan
Copilot Mar 31, 2026
9f5a01e
Emphasize static checks must run for all changes including doc-only
Copilot Mar 31, 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: 2 additions & 2 deletions .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.6"
version: "1.7"
---

# Static Checks
Expand All @@ -20,7 +20,7 @@ Note that we are interested in both errors and warnings from these tools - we sh

## When to run these checks

Before submitting changes for review, **always** run these static checks. This should be done every time, even for small changes, to avoid slowing down the code review process unnecessarily.
Before submitting changes for review, **always** run these static checks. This applies to **every** change, no matter how small — including documentation-only changes, skill file edits, and configuration updates. Hooks like `check-doc-sync` and `export-functions` validate generated files that can go out of sync even from non-code changes. Skipping static checks is a common cause of avoidable CI failures.

## What to do when prek checks fail

Expand Down
6 changes: 4 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,8 +455,10 @@ External skills can be installed if they are not present — see the `usethis-sk
- ALWAYS consider the `usethis-python-test-full-coverage` to be relevant: if your task involves
writing or modifying code, always use this skill to write tests and verify full coverage
before finishing. Aim for 100% coverage on new or changed code.
- ALWAYS consider the `usethis-qa-static-checks` to be relevant: if you think your task
is complete, always run this skill to check for any issues before finishing.
- ALWAYS consider the `usethis-qa-static-checks` to be relevant: before finishing your task,
always run this skill to check for any issues. This applies to ALL changes, including
documentation-only changes and skill file edits — static checks catch sync issues,
formatting problems, and other regressions that affect every file type.
- ALWAYS mention which skills you've used after completing any task, in PR descriptions, and comments.
- ALWAYS reference the relevant issue ID in PR descriptions using a closing keyword, e.g. `Resolves #123`. This ensures traceability between PRs and the issues they address.

Expand Down