tomevault-io PR Conventions
Full Commit History Analysis
When creating a pull request, always analyse the full commit history — not just the latest commit.
- Use
git diff [base-branch]...HEADto see all changes since the branch diverged - Use
git log [base-branch]..HEADto review every commit message - Draft a comprehensive PR summary that covers ALL commits, not just the most recent one
Test Plan Requirement
Every PR must include a Test plan section with a bulleted TODO checklist:
## Test plan
- [ ] Unit tests pass for new functionality
- [ ] Integration tests cover the critical path
- [ ] Manual verification of [specific behaviour]
- [ ] Edge cases tested: [list them]
Branch Push Convention
When pushing a new branch for the first time, always use the -u flag:
git push -u origin <branch-name>
Converted and distributed by TomeVault — claim your Tome and manage your conversions.