Documentation
README
PR Hygiene
Turn the current work into a PR a human can review in one pass.
Before opening
- Branch contains one logical change (or clearly labeled stacked commits)
- No leftover
console.log,debugger,TODO: temp, commented-out blocks you added - No unrelated formatting-only churn
- Secrets,
.env, and local-only files are not staged - Diff matches the stated goal โ nothing "extra helpful"
Description template
Use this structure (adapt section names to the host: GitHub/GitLab):
## Summary
<1โ3 bullets: what and why>
## Test plan
- [ ] <how you verified>
- [ ] <edge case worth checking>
## Notes
<risks, follow-ups, screenshots if UI>
Commit / PR title
This is the opening of the README. Read the full README on GitHub.