Skip to content

docs: add PR merge readiness checklist#492

Open
Thump604 wants to merge 1 commit intowaybarrios:mainfrom
Thump604:docs/issue-482-pr-readiness-checklist
Open

docs: add PR merge readiness checklist#492
Thump604 wants to merge 1 commit intowaybarrios:mainfrom
Thump604:docs/issue-482-pr-readiness-checklist

Conversation

@Thump604
Copy link
Copy Markdown
Collaborator

@Thump604 Thump604 commented May 2, 2026

Addresses #482.

This adds an in-repo PR template checklist for the process failures identified in the self-merge audit:

  • authors should not merge their own substantive PRs
  • latest CI for the exact head commit should be green before merge
  • post-review rebases/conflict fixes need a fresh green CI run
  • actionable review comments should be resolved or linked to follow-up issues before merge
  • intentional follow-up debt should be visible in the PR body

This does not replace branch protection or repository admin settings. It is a lightweight visible guardrail inside the repository so contributors and maintainers see the expected merge-readiness checks on every PR.

Validation:

  • docs/template-only change
  • git diff --check

Copy link
Copy Markdown
Collaborator

@janhilgard janhilgard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean docs-only PR. The checklist covers the right failure modes from the self-merge audit — particularly "latest CI for the exact head commit" (not a stale run) and "fresh CI after post-review rebase" which are easy to miss in practice.

The "I am not merging my own substantive PR" checkbox is a good social guardrail even without branch protection enforcement.

LGTM.

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.

2 participants