diff --git a/common-flow.md b/common-flow.md index 6c50348..33503ae 100644 --- a/common-flow.md +++ b/common-flow.md @@ -10,6 +10,8 @@ the [original variant](http://scottchacon.com/2011/08/31/github-flow.html) of [GitHub Flow](https://guides.github.com/introduction/flow/), while taking into account how a lot of open source projects use git. +Core rules: + - The `master` branch should always be deployable / usable. - New work must be done on a descriptively named change branch created off of `master`. @@ -17,22 +19,19 @@ into account how a lot of open source projects use git. named branch on the remote server. - When you need feedback, help, or think the branch is ready for merging, open a pull request. -- After someone else has reviewed and signed off on the change, you can merge - it in to `master`. +- After someone else has reviewed and signed off on the change, you can merge it + in to `master`. - New releases are created by committing a version bump commit directly to `master`, and then tagging that commit with the version. -### Branch Types +Branch types: + +- **Master Branch:** Should always be deployable / usable, is considered + "bleeding edge", and must be named `master`. +- **Change Branches:** Any branch that introduces changes (new feature, bug fix, + etc), should be cut from `master` (in most cases), and must have a descriptive + name. +- **Maintenance Branches:** Used to maintain old versions, and should follow a + `stable-X.Y` naming pattern, where `X` is MAJOR version and `Y` is MINOR + version. -- **Master Branch:** - - Should always be deployable / usable - - Is considered "bleeding edge" - - Must be named `master` -- **Change Branches:** - - Any branch that introduces changes (new feature, bug fix, etc) - - Should be cut from `master` (in most cases) - - Must have a descriptive name -- **Maintenance Branches:** - - Used to maintain old versions (back-porting security patches, etc) - - Should follow a `stable-X.Y` naming pattern, where `X` is MAJOR version - and `Y` is MINOR version