Repository files navigation

A collection of Git extensions to provide high-level repository operationsfor Vincent Driessen'sbranching model.

For the best introduction to get started withgit flow, please read JeffKreeftmeijer's blog post:

http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/

Or have a look at one of these screen casts:

• How to use a scalable Git branching model called git-flow (by Build a Module)
• A short introduction to git-flow (by Mark Derricutt)
• On the path with git-flow (by Dave Bock)

See the Wiki for up-to-dateInstallation Instructions.

For those who use theBash orZSH shell, please check out the excellent work on thegit-flow-completion projectbybobthecow. It offers tab-completion for allgit-flow subcommands and branch names.

See theFAQ section of the projectWiki.

This project is still under development. Feedback and suggestions are verywelcome and I encourage you to use theIssueslist on Github to provide thatfeedback.

Feel free to fork this repo and to commit your additions. For a list of allcontributors, please see theAUTHORS file.

Any questions, tips, or general discussion can be posted to our Google group:http://groups.google.com/group/gitflow-users

Fork the repository. Then, run:

git clone --recursive git@github.com:<username>/gitflow.gitcd gitflowgit branch master origin/mastergit flow init -dgit flow feature start <your feature>

Then, do work and commit your changes.Hint:export PATH=`pwd`:$PATHfrom within the gitflow directory makes sure you're using the version ofgitflow you're currently developing.

git flow feature publish <your feature>

When done, open a pull request to your feature branch.

git-flow is published under the liberal terms of the BSD License, see theLICENSE file. Although the BSD License does not require you to shareany modifications you make to the source code, you are very much encouraged andinvited to contribute back your modifications to the community, preferablyin a Github fork, of course.

To initialize a new repo with the basic branch structure, use:

git flow init [-d]

This will then interactively prompt you with some questions on which branchesyou would like to use as development and production branches, and how youwould like your prefixes be named. You may simply press Return on any ofthose questions to accept the (sane) default suggestions.

The-d flag will accept all defaults.

• To list/start/finish feature branches, use:

    git flow feature  git flow feature start <name> [<base>]  git flow feature finish <name>

  For feature branches, the<base> arg must be a commit ondevelop.

• To push/pull a feature branch to the remote repository, use:

    git flow feature publish <name>    git flow feature pull <remote> <name>

• To list/start/finish release branches, use:

    git flow release  git flow release start <release> [<base>]  git flow release finish <release>

  For release branches, the<base> arg must be a commit ondevelop.

• To list/start/finish hotfix branches, use:

    git flow hotfix  git flow hotfix start <release> [<base>]  git flow hotfix finish <release>

  For hotfix branches, the<base> arg must be a commit onmaster.

• To list/start support branches, use:

    git flow support  git flow support start <release> <base>

  For support branches, the<base> arg must be a commit onmaster.

A few people already requested it, so now it's here: a Flattr button.

Of course, the best way to show your appreciation for the originalblog post or the git-flow tool itself remainscontributing to the community. If you'd like to show your appreciation inanother way, however, consider Flattr'ing me: