Skip to content

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

Merged
nathanjmcdougall merged 2 commits intomainfrom
copilot/update-agents-md-static-checks-emphasis
Mar 31, 2026
Merged

Emphasize static checks are required for all changes, including doc-only#1669
nathanjmcdougall merged 2 commits intomainfrom
copilot/update-agents-md-static-checks-emphasis

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 31, 2026

In #1665, the agent skipped static checks for a documentation-only change. The existing AGENTS.md wording ("if you think your task is complete") was too conditional—agents interpreted it as optional for non-code changes.

  • AGENTS.md: Rewrote the usethis-qa-static-checks bullet to remove conditional phrasing and explicitly state it applies to ALL changes including doc-only and skill edits, with rationale (sync issues, formatting)
  • usethis-qa-static-checks SKILL.md: Expanded "When to run" to name concrete hooks (check-doc-sync, export-functions) that catch non-code regressions; bumped version 1.6 → 1.7

- Updated AGENTS.md to explicitly state static checks apply to ALL changes
  including documentation-only changes and skill file edits
- Updated usethis-qa-static-checks SKILL.md with concrete examples of hooks
  that catch non-code regressions (check-doc-sync, export-functions)
- Bumped skill version 1.6 → 1.7

Resolves #1666

Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/857e36e6-f481-42a2-af79-1e6db303df34

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot AI changed the title [WIP] Update AGENTS.md to emphasize running static checks for doc-only changes Emphasize static checks are required for all changes, including doc-only Mar 31, 2026
Copilot AI requested a review from nathanjmcdougall March 31, 2026 21:59
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review March 31, 2026 22:03
@nathanjmcdougall nathanjmcdougall merged commit b21c285 into main Mar 31, 2026
1 check passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/update-agents-md-static-checks-emphasis branch March 31, 2026 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Put more emphasis on the need to run static checks even for doc-only changes

2 participants