-
Notifications
You must be signed in to change notification settings - Fork 42
Pr Author Checklist
github-actions[bot] edited this page Feb 23, 2026
·
1 revision
Run a pre-submit readiness checklist against any pull request. The agent scores the PR on 15 dimensions — description quality, CI status, diff size, test coverage, reviewer readiness, and more — before you request review.
- Before clicking "Request review" on a PR you authored
- Teaching junior contributors what a good PR looks like
- Catching missing test coverage, vague descriptions, or CI failures before reviewers notice
- Getting an objective readiness score to decide if the PR is ready
In GitHub Copilot Chat:
/pr-author-checklist owner/repo#123
Or for the current branch:
/pr-author-checklist
- Fetch PR — Reads description, diff, CI status, linked issues, and existing comments
- Score 15 dimensions — Each area is graded pass / warning / fail
- Compute overall score — 0-100 with an A-F grade
- Highlight blockers — Any fails that should be resolved before requesting review
- Provide specific fixes — For failing dimensions, the agent explains what to add or change
| Dimension | What is checked |
|---|---|
| PR description | Has a purpose statement and explains the "why" |
| Linked issue | References at least one issue with Closes #N or Fixes #N
|
| CI passing | All required checks are green |
| Diff size | Under 400 lines (warning at 300, fail above 600) |
| Test coverage | New code has corresponding test files |
| No debug code | No console.log, TODO, or debugging artifacts |
| No secret leaks | No hard-coded credentials or API keys |
| File scope | Changes stay within described scope |
| Breaking changes | Noted and migration path documented if any |
| Reviewer assignment | At least one reviewer assigned |
| Screenshots/demo | UI changes have screenshots |
| Changelog entry | If project uses changelog files |
| Commit message quality | Descriptive, follows project conventions |
| Self-review | Evidence of author's own review (comments, resolved todos) |
| Draft status | Not marked as draft if genuinely ready |
PR Readiness: owner/repo#123 — 78/100 (C+)
✅ Description — Clear purpose and context
✅ Linked issue — Closes #89
❌ CI — 1 check failing: unit-tests
⚠️ Diff size — 320 lines (approaching limit)
✅ No debug code
✅ Reviewer assigned
Action needed before requesting review:
1. Fix unit-test failure in src/auth.test.ts:line 44
/pr-author-checklist # Current branch PR
/pr-author-checklist owner/repo#123 # Specific PR
/pr-author-checklist strict # Treat warnings as failures
| Agent | Role |
|---|---|
| pr-review agent | Executes this prompt |
- review-pr — full reviewer-perspective review
- pr-comment — add a specific comment to the PR
- manage-pr — merge when everything is ready
- Accessibility Lead
- Web Accessibility Wizard
- Document Accessibility Wizard
- Alt Text and Headings
- ARIA Specialist
- Contrast Master
- Forms Specialist
- Keyboard Navigator
- Link Checker
- Live Region Controller
- Modal Specialist
- Tables Data Specialist
- Word Accessibility
- Excel Accessibility
- PowerPoint Accessibility
- PDF Accessibility
- Office Scan Config
- PDF Scan Config
- Testing Coach
- WCAG Guide