github/skopeo
1
0
Fork 0
mirror of https://github.com/containers/skopeo.git synced 2025-09-14 05:50:56 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #444 from mtrmac/contributing-commits

Browse Source 
Modify CONTRIBUTING.md to prefer smaller commits over squashing them
This commit is contained in:
Antonio Murdaca
2017-11-06 16:31:37 +01:00
committed by GitHub
parent 62c68998d7 63b3be2f13
commit 0d0055df05
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -49,9 +49,9 @@ Regardless of the type of PR, all PRs should include:
* documentation changes * documentation changes
Squash your commits into logical pieces of work that might want to be reviewed Squash your commits into logical pieces of work that might want to be reviewed
separate from the rest of the PRs. But, squashing down to just one commit is ok separate from the rest of the PRs. Ideally, each commit should implement a single
too since in the end the entire PR will be reviewed anyway. When in doubt, idea, and the PR branch should pass the tests at every commit. GitHub makes it easy
squash. to review the cumulative effect of many commits; so, when in doubt, use smaller commits.
PRs that fix issues should include a reference like `Closes #XXXX` in the PRs that fix issues should include a reference like `Closes #XXXX` in the
commit message so that github will automatically close the referenced issue commit message so that github will automatically close the referenced issue