Skip to content

Commit

Permalink
Clarify merging strategy use-case
Browse files Browse the repository at this point in the history
  • Loading branch information
agis committed Mar 31, 2015
1 parent 310101f commit f387cab
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ If you feel like contributing, go ahead, fork it and open a pull request.

* You want to tidy up your branch (ie. squash/reorder commits, reword
messages) and/or rebase it onto the 'master' branch *just before you
merge it*
merge it*.

That said, *never rewrite the history of the `master` branch* or any other
"important" branches (ie. used by production or CI servers).
Expand All @@ -162,6 +162,10 @@ If you feel like contributing, go ahead, fork it and open a pull request.
This results in a branch that can be applied directly to the end of the
`master` branch and results in a very simple history.

*(Note: This workflow is better suited for projects with short-running
branches. Otherwise it might be better to occassionally merge the branch
instead of rebasing onto it.)*

* If your branch includes more than one commit, do not merge with a
fast-forward:

Expand Down

0 comments on commit f387cab

Please sign in to comment.