Skip to content

Commit 42c4996

Browse files
author
wodry
authored
Docs: Improve readability of "Squashing commits"
It was not easy to read the comment lines for me because I was not sure whether the sentence ended with the line or not ("pull set commits"?). Therefore, dots had been invented and I have added them to signal the end of a sentence. Also begin New sentence with a capital letter. I guess, not all 'pick' words should be replaced by 'squash'? At least I found [https://www.digitalocean.com/community/tutorials/how-to-rebase-and-update-a-pull-request](this) rebase/squash documentation helpful, where is written that the first line should not be changed.
1 parent a90ca40 commit 42c4996

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,10 @@ before it will be merged. The basic squashing workflow is shown below.
127127

128128
git checkout your_branch_name
129129
git rebase -i HEAD~n
130-
# n is normally the number of commits in the pull
131-
# set commits from 'pick' to 'squash', save and quit
132-
# on the next screen, edit/refine commit messages
133-
# save and quit
130+
# n is normally the number of commits in the pull request.
131+
# Set commits (except the one in the first line) from 'pick' to 'squash', save and quit.
132+
# On the next screen, edit/refine commit messages.
133+
# Save and quit.
134134
git push -f # (force push to GitHub)
135135

136136
If you have problems with squashing (or other workflows with `git`), you can

0 commit comments

Comments
 (0)