Commits and PR packaging should preserve causality

A readable commit sequence helps a reviewer connect the task, test, fix, and documentation. Avoid a single “fix stuff” commit when separate reviewable steps make the reasoning clearer.

Commit history is context, not a substitute for reviewing the final diff.

Commit purposePossible content
EvidenceReproduction or characterization check
FixSmall implementation change
HandoffDocs, notes, or updated verification contract

Packaging checklist

  1. Keep each commit within the task boundary.
  2. Use a message that names the purpose.
  3. Inspect status, diff, and commit summary.
  4. Run the required checks before handoff.
  5. Write the PR description from actual evidence.
  6. List unverified areas and follow-up work.

PR description skeleton

## Goal
<task outcome>

## Change
<bounded summary>

## Verification
<commands actually run>

## Risks and limits
<remaining items>

## Boundary
Documented example where execution evidence is absent.

Canonical lesson source · JavaRush

Open JavaRush material