github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a note on when to use commits

Browse Source
This commit is contained in:
Tim Hockin 2015-07-30 15:11:38 -07:00
parent ed9975b031
commit c58e3fbbb6
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/devel/development.md
View File

@ -99,6 +99,17 @@ git push -f origin myfeature
1. Visit http://github.com/$YOUR_GITHUB_USERNAME/kubernetes 1. Visit http://github.com/$YOUR_GITHUB_USERNAME/kubernetes
2. Click the "Compare and pull request" button next to your "myfeature" branch. 2. Click the "Compare and pull request" button next to your "myfeature" branch.
### When to retain commits and when to squash
Upon merge, all git commits should represent meaningful milestones or units of
work. Use commits to add clarity to the development and review process.
Before merging a PR, squash any "fix review feedback", "typo", and "rebased"
sorts of commits. It is not imperative that every commit in a PR compile and
pass tests independently, but it is worth striving for. For mass automated
fixups (e.g. automated doc formatting), use one or more commits for the
changes to tooling and a final commit to apply the fixup en masse. This makes
reviews much easier.
## godep and dependency management ## godep and dependency management