Skip to content

docs: add examples for 'one logical change' in onboarding #61189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Himanshuxzx wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −1
Open

docs: add examples for 'one logical change' in onboarding #61189

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion onboarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,12 @@ Commits in one pull request that belong to one logical change should
be squashed. It is rarely the case in onboarding exercises, so this
needs to be pointed out separately during the onboarding.

<!-- TODO(joyeechueng): provide examples about "one logical change" -->
Examples of "one logical change":
- A bug fix that includes the code change and corresponding test updates.
- A new feature implementation in a single module.
- A refactoring of a specific function or class.

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.

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

Expand Down
Loading