{"id":11,"date":"2017-05-20T08:49:37","date_gmt":"2017-05-20T08:49:37","guid":{"rendered":"https:\/\/blogs.scummvm.org\/yinsimei\/?p=11"},"modified":"2022-05-24T08:53:15","modified_gmt":"2022-05-24T08:53:15","slug":"git-tips-keep-your-branch-clean-and-clear-for-a-pr","status":"publish","type":"post","link":"https:\/\/blogs.scummvm.org\/yinsimei\/2017\/05\/20\/git-tips-keep-your-branch-clean-and-clear-for-a-pr\/","title":{"rendered":"Git tips: keep your branch clean and clear for a PR"},"content":{"rendered":"

When contributing to a open source project, we should keep commits clean and clear in the pull request that we create. In this case,\u00a0rebase,<\/strong>\u00a0reset\u00a0<\/strong>are important git operations that we\u2019d better get familiar with.<\/p>\n

Get to know about git-reset and git-rebase<\/h1>\n

git-reset<\/h2>\n

git-reset<\/a>\u00a0works with refs, on your working directory and the index, without touching any commit objects (or other objects).<\/p>\n

git-rebase<\/h2>\n

git-rebase<\/a>\u00a0on the other hand is used to rewrite previously made commit objects. So if you want to rewrite the history, git-rebase is what you want. Note that you should never rewrite history that was pushed and was available to someone else, as rebasing rewrites the objects making them incompatible with the old objects, resulting in a mess for anyone else involved.<\/p>\n

Some use case examples<\/h1>\n

Once we\u2019ve seen how basic operations work in git, there are a number of things that we can achieve with them.<\/p>\n

Update a fork without pushing merge commit<\/h3>\n
\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n
6<\/div>\n
7<\/div>\n
8<\/div>\n<\/td>\n
\n
\n
# fetch<\/code><\/div>\n
$ git fetch upstream <\/code><\/div>\n
<\/div>\n
# rebase branch on top of upstream\/master<\/code><\/div>\n
$ git checkout myBranch git rebase upstream<\/code>\/master<\/code><\/div>\n
<\/div>\n
# force a push to update<\/code><\/div>\n
$ git push -f<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n
\n

Deal with\u00a0local<\/strong>\u00a0commits (unpushed)<\/h2>\n

Undo commit(s)<\/h3>\n

Undo last commit and abandon all the changes (never see them again)
\n<\/strong><\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n<\/td>\n
\n
\n
$ git reset --hard HEAD~1<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Undo last commit and keep all the changes (to be reedited later)
\n<\/strong><\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n<\/td>\n
\n
\n
# leave the files alone<\/code><\/div>\n
$ git reset HEAD~1<\/code><\/div>\n
<\/div>\n
# leave the files and the index alone<\/code><\/div>\n
$ git reset --soft HEAD~1<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n
\n

Deal with pushed commits (rewrite commit history)<\/strong><\/h2>\n

ATTENTION, for all the operations below, don\u2019t use them if someone has already pulled your change. Only for your personal repository. Else, we should use\u00a0revert\u00a0<\/strong>and create a relative commit for it.<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n
6<\/div>\n<\/td>\n
\n
\n
# revert one single commit<\/code><\/div>\n
$ git revert <commit_hash><\/code><\/div>\n
<\/div>\n
# revert a range of commits<\/code><\/div>\n
# <oldest_commit_hash> is the oldest commit that we want to keep and won't be removed<\/code><\/div>\n
$ git revert <oldest_commit_hash>..<latest_commit_hash><\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Suppose we work on the branch\u00a0myBranch<\/strong>\u00a0and command\u00a0git log<\/strong>\u00a0gives:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n
6<\/div>\n
7<\/div>\n
8<\/div>\n
9<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n<\/td>\n
\n
\n
commit eb6e1791690c2498891071ecc944bb381b413732<\/code><\/div>\n
Author: AAA <github.com@ccc.com>\u00a0 Date: ...<\/code><\/div>\n
Commit 6<\/code><\/div>\n
<\/div>\n
commit 8c9e5dbe40fe4dfd83aa1425c6a71c9b271d33e7<\/code><\/div>\n
Author: AAA <aaa@gmail.com>\u00a0 Date: ...<\/code><\/div>\n
Commit 5<\/code><\/div>\n
<\/div>\n
commit 53b0b82e8754e5e74dda2dedd9f7da726b068df7<\/code><\/div>\n
Author: BBB <bbb@gmail.com>\u00a0 Date: ...<\/code><\/div>\n
Commit 4<\/code><\/div>\n
<\/div>\n
commit 2a7cda649ebea7997d5a6ac74c23569f2b0b83d9<\/code><\/div>\n
Author: CCC <ccc@scummvm.org>\u00a0 Date: ...<\/code><\/div>\n
Commit 3<\/code><\/div>\n
<\/div>\n
commit c788642b72ea524d720e36b28bf9e87e7b06fd28<\/code><\/div>\n
Author: DDD <github.com@ddd.com>\u00a0 Date: ...<\/code><\/div>\n
Commit 2<\/code><\/div>\n
<\/div>\n
commit b7638982c2a7b619494108224e956a95bec88f08<\/code><\/div>\n
Author: EEE <github@bbb.n>\u00a0 Date: ...<\/code><\/div>\n
Commit 1<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

<\/h3>\n

Squash several commits<\/h3>\n

Squash last 3 commits<\/strong>:<\/h4>\n
\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n<\/td>\n
\n
\n
# rewrite history for last 3 commits<\/code><\/div>\n
$ git rebase -i HEAD~3<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Then, text editor will show you:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n<\/td>\n
\n
\n
pick eb6e179 Commit 6<\/code><\/div>\n
pick 8c9e5db Commit 5<\/code><\/div>\n
pick 53b0b82 Commit 4<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Change it to:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n<\/td>\n
\n
\n
# squash commit 4 5 into commit 6<\/code><\/div>\n
pick eb6e179 Commit 6<\/code><\/div>\n
squash 8c9e5db Commit 5<\/code><\/div>\n
squash 53b0b82 Commit 4<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Save and quit. Done.<\/p>\n

Squash all commits in a branch into one commit :<\/strong><\/h4>\n
\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n<\/td>\n
\n
\n
$ git checkout myBranch<\/code><\/div>\n
$ git reset $(git merge-base master myBranch)<\/code><\/div>\n
$ git add -A<\/code><\/div>\n
$ git commit -m <\/code>\"one commit on myBranch\"<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Squash commits 2 4 6 into one single commit (non consecutive commits)<\/strong>:<\/h4>\n
\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n<\/td>\n
\n
\n
# rewrite history for last 5 commits(2 3 4 5 6)<\/code><\/div>\n
$ git rebase -i HEAD~5<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Then, text editor will show us:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n<\/td>\n
\n
\n
pick eb6e179 Commit 6<\/code><\/div>\n
pick 8c9e5db Commit 5<\/code><\/div>\n
pick 53b0b82 Commit 4<\/code><\/div>\n
pick 2a7cda6 Commit 3<\/code><\/div>\n
pick c788642 Commit 2<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Reorder commits to be squashed together:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n<\/td>\n
\n
\n
pick 8c9e5db Commit 5<\/code><\/div>\n
pick 2a7cda6 Commit 3<\/code><\/div>\n
pick eb6e179 Commit 6<\/code><\/div>\n
squash 53b0b82 Commit 4<\/code><\/div>\n
squash c788642 Commit 2<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Save and quit. Done<\/p>\n

<\/h3>\n

Remove commit(s)<\/h3>\n

Remove last commit(s) :<\/strong><\/h4>\n
\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n<\/td>\n
\n
\n
# Get back to the last known good commit(Commit 4 for example, so 5 6 are removed)<\/code><\/div>\n
$ git push -f origin 53b0b82e8754e5e74dda2dedd9f7da726b068df7:myBranch<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Remove commits 2 4 6 (use rebase) :<\/strong><\/h4>\n
\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n<\/td>\n
\n
\n
# rewrite history for last 5 commits(2 3 4 5 6)<\/code><\/div>\n
$ git rebase -i HEAD~5<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Then, text editor will show us:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n<\/td>\n
\n
\n
pick eb6e179 Commit 6<\/code><\/div>\n
pick 8c9e5db Commit 5<\/code><\/div>\n
pick 53b0b82 Commit 4<\/code><\/div>\n
pick 2a7cda6 Commit 3<\/code><\/div>\n
pick c788642 Commit 2<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Delete all the lines of unwanted commits:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n<\/td>\n
\n
\n
pick 8c9e5db Commit 5<\/code><\/div>\n
pick 2a7cda6 Commit 3<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Save and quit. Done.<\/p>\n

Remove commits 2 4 6 (use cherry-pick):<\/strong><\/h4>\n
\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n
6<\/div>\n
7<\/div>\n
8<\/div>\n
9<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n<\/td>\n
\n
\n
$ git checkout myBranch<\/code><\/div>\n
<\/div>\n
# checkout the last usable commit (Commit 1)<\/code><\/div>\n
$ git checkout b7638982c2a7b619494108224e956a95bec88f08<\/code><\/div>\n
<\/div>\n
# create a new branch to work on<\/code><\/div>\n
$ git checkout -b repair<\/code><\/div>\n
<\/div>\n
# cherry pick commits that we want to keep (Commmit 3 5)<\/code><\/div>\n
$ git cherry-pick 2a7cda649ebea7997d5a6ac74c23569f2b0b83d9<\/code><\/div>\n
$ git cherry-pick 8c9e5dbe40fe4dfd83aa1425c6a71c9b271d33e7<\/code><\/div>\n
<\/div>\n
# back to myBranch<\/code><\/div>\n
$ git checkout myBranch<\/code><\/div>\n
<\/div>\n
# reset myBranch to last usable commit (Commit 1)<\/code><\/div>\n
$ git reset --hard b7638982c2a7b619494108224e956a95bec88f08<\/code><\/div>\n
<\/div>\n
# merge our repair branch onto myBranch<\/code><\/div>\n
$ git merge repair<\/code><\/div>\n
<\/div>\n
# push to update<\/code><\/div>\n
$ git push --hard origin myBranch<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n
\n

 <\/p>\n

Resources:<\/h1>\n