PR Merge Readiness
Use this skill when the user wants a final pre-merge pass for a feature branch.
Goals
- Compare branch diff against
main. - Confirm user-visible changes have matching docs updates.
- Add or refine
CHANGELOG.mdentries underUnreleased. - Surface warnings/risks before merge.
Workflow
- Gather diff scope:
git diff --name-status main...HEADgit diff --stat main...HEAD
- Classify changed files:
- Core solver (
source/), bindings, tests, docs, CI, packaging.
- Core solver (
- Docs consistency check:
- If behavior/API changed, verify
README.mdand/ordocs/source/updates exist. - If docs are missing, flag as warning and propose exact files to update.
- If behavior/API changed, verify
- Changelog update:
- Add concise user-visible bullets under
## [Unreleased]inCHANGELOG.md. - Use sections already present (
Changed,Fixed,Added).
- Add concise user-visible bullets under
- Sanity checks:
- Confirm no accidental edits to generated docs/build outputs.
- Highlight risky areas: missing tests, interface changes, scientific/numerical behavior impacts.
- Produce merge recommendation:
Ready,Ready with warnings, orNot ready.
Output Format
- Findings first, ordered by severity, with file references.
- Proposed
CHANGELOG.mdadditions. - Final merge-readiness verdict and blockers.
Guardrails
- Do not merge branches automatically.
- Do not rewrite changelog history outside
Unreleasedunless user asks. - Keep warnings concrete and evidence-based.