aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwodry <wodry@users.noreply.github.com>2018-06-17 10:47:50 +0200
committerGitHub <noreply@github.com>2018-06-17 10:47:50 +0200
commit42c499614a6426741c27765cc36cb9eb256fe5e3 (patch)
tree44cbb2c627b6304e438cf2dbf53d46e26ec767ab
parenta90ca4087a6f0d7a0e22ce2769f3b0588d75b293 (diff)
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.
-rw-r--r--CONTRIBUTING.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c390595abf..3ee5a04796 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -127,10 +127,10 @@ before it will be merged. The basic squashing workflow is shown below.
git checkout your_branch_name
git rebase -i HEAD~n
- # n is normally the number of commits in the pull
- # set commits from 'pick' to 'squash', save and quit
- # on the next screen, edit/refine commit messages
- # save and quit
+ # n is normally the number of commits in the pull request.
+ # Set commits (except the one in the first line) from 'pick' to 'squash', save and quit.
+ # On the next screen, edit/refine commit messages.
+ # Save and quit.
git push -f # (force push to GitHub)
If you have problems with squashing (or other workflows with `git`), you can