Skip to content

Commit

Permalink
Add a note on when to use commits
Browse files Browse the repository at this point in the history
  • Loading branch information
thockin committed Jul 30, 2015
1 parent ed9975b commit c58e3fb
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/devel/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit c58e3fb

Please sign in to comment.