@@ -34,12 +34,30 @@ GitHub generates branch names in the format `<issue-number>-<issue-title-slug>`
3434(e.g., ` 42-fix-login-bug ` ). Following this pattern ensures consistency whether the branch
3535is created automatically or manually.
3636
37+ #### Writing Commit Messages
38+
39+ Since PRs are squash-merged, individual commits don't need to be release-note quality—but
40+ good commit messages still help reviewers and your future self understand the progression of changes.
41+
42+ ** Do:**
43+ - Write short, descriptive summaries (e.g., ` Add validation for empty input ` )
44+ - Use commits to mark logical checkpoints (e.g., ` WIP: basic structure ` , ` Add tests ` , ` Fix edge case ` )
45+ - Feel free to use ` WIP ` , ` fixup ` , or ` checkpoint ` prefixes for in-progress work
46+
47+ ** Don't:**
48+ - Reference issue numbers in commit messages—the PR description handles issue linking
49+ - Worry about perfect formatting—squash merge discards individual commit messages
50+ - Write multi-paragraph commit bodies unless the context is genuinely useful for review
51+
3752### 3. Opening a Pull Request
3853
3954Open a Pull Request when the work is ready for review or merge.
4055
4156- The PR title ** must be release-note quality** (it will appear verbatim in release notes)
42- - The PR description should reference the issue using one of the following:
57+ - ** Do not include issue references in the PR title** – GitHub automatically appends the PR number
58+ during squash merge, so including ` #<issue-number> ` in the title results in duplicate references
59+ (e.g., ` Fix bug (#42) (#43) ` )
60+ - Reference the issue in the ** PR description** using one of the following:
4361 - ` Fixes #<issue-number> ` – closes the issue when merged
4462 - ` Refs #<issue-number> ` – links the issue without closing it
4563
0 commit comments