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 purpose | Possible content |
|---|---|
| Evidence | Reproduction or characterization check |
| Fix | Small implementation change |
| Handoff | Docs, notes, or updated verification contract |
Packaging checklist
- Keep each commit within the task boundary.
- Use a message that names the purpose.
- Inspect status, diff, and commit summary.
- Run the required checks before handoff.
- Write the PR description from actual evidence.
- 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