Add pr-review agent skill#865
Closed
drbenvincent wants to merge 2 commits into
Closed
Conversation
New .github/skills/pr-review/ skill capturing the review patterns distilled from the PR #826 review iteration. Provides an orchestrator SKILL.md plus six focused reference files: workflow, severity-sorted look-fors, CausalPy code conventions, docs/notebook conventions, comment-drafting templates, and an extension/pruning protocol so the skill stays sharp as patterns get formalised into hooks. Designed to complement (not duplicate) the existing pr-to-green and pr-workflows skills; explicitly defers mechanical checks to hooks/CI. Made-with: Cursor
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #865 +/- ##
==========================================
- Coverage 94.60% 94.59% -0.02%
==========================================
Files 80 80
Lines 12764 12764
Branches 770 770
==========================================
- Hits 12076 12074 -2
- Misses 485 486 +1
- Partials 203 204 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
The validate-notebooks pre-commit hook (#866) deterministically enforces exactly one top-level H1 per docs notebook, so the pr-review skill no longer needs to flag it. Remove the dedicated section from docs-patterns.md and trim the now-stale examples from SKILL.md and the docs-patterns intro. Keep the how-to-extend.md bullet as the worked example of the "formalise into a hook → prune from the skill" maintenance rule. Made-with: Cursor
Collaborator
Author
|
Closing this draft in favor of #920. I folded the strongest pieces from this PR into the new |
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.
Summary
Adds
.github/skills/pr-review/— a new agent skill capturing the review patterns distilled from the #826 review iteration into a reusable form.Structure:
SKILL.md(orchestrator, ~75 lines, well under the spec's 500-line / 5000-token recommendation)reference/workflow.md— the 6-step review workflow with concreteghcommands and a claim-verification tablereference/what-to-look-for.md— severity-sorted patterns (4 must-fix, 6 should-fix, 7 nits, 3 process), each with a canonical example from Add outcome falsification, random placebo folds, and model clone support #826 and a "how to spot" diagnosticreference/code-patterns.md— CausalPy source-code conventions (BaseExperiment,PyMCModel,_clone(),__repr__, custom exceptions, type hints, helper-promotion checklist)reference/docs-patterns.md— notebook + docs conventions (single-H1, hide-input/hide-output, sampler warnings, glossary linking, MyST roles, citations, file placement)reference/posting-comments.md— comment templates (multi-item summary, status update, inline suggestion, correction), tone-calibration with 3-variant offering, attribution rulesreference/how-to-extend.md— when to add patterns (recur 2+ times), when to prune (formalised into hooks), required structure for new entries, six-monthly review cadenceDesign choices worth flagging
pr-to-greenorpr-workflows— explicitly delegates fix-PR work to the former and create-PR work to the latter. New skill is read-and-diagnose only.SKILL.mdandposting-comments.md. Same for never auto-approving viagh pr review --approve.how-to-extend.mddocuments the 4-element template (ID, title, canonical example, how-to-spot) and the rule that anything formalised into a hook must be removed from the skill at the same time.reference/(singular) matching the existinggithub-issues/andpr-workflows/skills, even though the spec at https://agentskills.io/specification suggestsreferences/.nameanddescription— matching local convention.Test plan
prek run --all-filespasses (skill files are markdown, picked up by trailing-whitespace / EOF / codespell hooks).Out of scope
issue-863-single-h1-check.Related
Made with Cursor