LBRYCommunity/lbrycrd
1
0
Fork 0
Code Issues 29 Pull requests 1 Projects Releases 32 Packages Wiki Activity

Docs: Improve readability of "Squashing commits"

Browse source 
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.
This commit is contained in:
wodry 2018-06-17 10:47:50 +02:00 committed by GitHub
parent a90ca4087a
commit 42c499614a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -127,10 +127,10 @@ before it will be merged. The basic squashing workflow is shown below.
git checkout your_branch_name git checkout your_branch_name
git rebase -i HEAD~n git rebase -i HEAD~n
# n is normally the number of commits in the pull # n is normally the number of commits in the pull request.
# set commits from 'pick' to 'squash', save and quit # Set commits (except the one in the first line) from 'pick' to 'squash', save and quit.
# on the next screen, edit/refine commit messages # On the next screen, edit/refine commit messages.
# save and quit # Save and quit.
git push -f # (force push to GitHub) git push -f # (force push to GitHub)
If you have problems with squashing (or other workflows with `git`), you can If you have problems with squashing (or other workflows with `git`), you can