Make Review Artifacts Standalone

REVIEW-MAKE-REVIEW-ARTIFACTS-STANDALONE

Summary

Put the needed problem, decision, context, validation, and risk in the issue, PR, commit, or handoff itself. Standalone artifacts make review and future debugging possible without private session context.

Rule

Make issues, PRs, commit messages, and review handoffs stand alone.

Why

Issues, PR descriptions, commit messages, and agent handoffs are read by people who did not see the chat, scratch notes, local plan, or discarded attempts. They need the problem, decision, relevant context, validation, and remaining risk in the artifact itself, not hidden in the development session that produced it.

Helps

  • Makes review possible without private context and leaves durable reasoning for future debugging, archaeology, and follow-up work.

Limits

Do not paste transcripts or long local notes. Summarize only the context that changes how a reviewer, maintainer, or future agent should understand the work.

For reusable source artifacts such as docs, templates, generated packs, or shared guidance, use SOURCE-MAKE-SHARED-ARTIFACTS-STANDALONE.

Agent Instruction

Make issues, PRs, commit messages, and handoffs stand alone for readers who did not see the chat,
notes, plan, or discarded attempts.

Mechanisms

Supported by issue and PR templates, commit-message bodies, review packets, ADR links, validation sections, and final handoff notes that restate private decisions in shared language.

References