diff options
| author | Tim Hockin <thockin@google.com> | 2015-07-30 15:11:38 -0700 |
|---|---|---|
| committer | Tim Hockin <thockin@google.com> | 2015-07-30 15:11:38 -0700 |
| commit | e605969e9a2636a2a1c4c1f86c7ea9596bbf3174 (patch) | |
| tree | 7ff1df526e0c05cd2f6432cf5a181536e8a599f6 /development.md | |
| parent | e0554bbf167b4c0d315fda4a3ddd9511460064c1 (diff) | |
Add a note on when to use commits
Diffstat (limited to 'development.md')
| -rw-r--r-- | development.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/development.md b/development.md index 27cb034d..87b4b5d0 100644 --- a/development.md +++ b/development.md @@ -99,6 +99,17 @@ git push -f origin myfeature 1. Visit http://github.com/$YOUR_GITHUB_USERNAME/kubernetes 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 |
