Skip to content

Commit 65c10a8

Browse files
committed
docs: add examples for 'one logical change' in onboarding
1 parent 05d6b9b commit 65c10a8

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

onboarding.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,12 @@ Commits in one pull request that belong to one logical change should
208208
be squashed. It is rarely the case in onboarding exercises, so this
209209
needs to be pointed out separately during the onboarding.
210210

211-
<!-- TODO(joyeechueng): provide examples about "one logical change" -->
211+
Examples of "one logical change":
212+
- A bug fix that includes the code change and corresponding test updates.
213+
- A new feature implementation in a single module.
214+
- A refactoring of a specific function or class.
215+
216+
Multiple commits should be squashed if they represent iterations on the same logical change (e.g., fixing review feedback). Commits that represent separate logical changes should remain separate.
212217

213218
## Exercise: Make a pull request adding yourself to the README
214219

0 commit comments

Comments
 (0)