From d7697410261f6c6dd134a5a8d13bc384855c4b7d Mon Sep 17 00:00:00 2001 From: Deltalank <196924839+Deltalank@users.noreply.github.com> Date: Sat, 20 Jun 2026 17:21:26 +0100 Subject: [PATCH] docs: add review readiness record Co-authored-by: CoderDeltaLAN <152043745+CoderDeltaLAN@users.noreply.github.com> --- docs/review-readiness-record.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/review-readiness-record.md diff --git a/docs/review-readiness-record.md b/docs/review-readiness-record.md new file mode 100644 index 0000000..00ddd74 --- /dev/null +++ b/docs/review-readiness-record.md @@ -0,0 +1,24 @@ +# Review readiness record + +Use this record to keep a small review ready for a clean close. + +## Readiness start + +- Confirm that upstream main is current. +- Confirm that the local main branch is clean. +- Confirm that the branch has one clear purpose. +- Confirm that the planned change is documentation only. + +## Readiness evidence + +- Record the changed file. +- Record that the pull request title matches the diff. +- Record that no secrets or personal data were added. +- Record that private context stayed out of repository files. + +## Readiness close + +- Wait for checks before approval. +- Merge only after review. +- Confirm that main contains the expected merge commit. +- Keep follow-up work for a separate branch.