git-theflow

A collection of Git extensions to provide high-level repository operations for Vincent Driessen's branching model.

Getting started

For the best introduction to get started with git theflow, please read Jeff Kreeftmeijer's blog post:

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

Or have a look at one of these screen casts:

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

Installing git-theflow

See the Wiki for up-to-date Installation Instructions.

Integration with your shell

For those who use the Bash or ZSH shell, please check out the excellent work on the git-theflow-completion project by bobthecow. It offers tab-completion for all git-theflow subcommands and branch names.

FAQ

See the FAQ section of the project Wiki.

Please help out

This project is still under development. Feedback and suggestions are very welcome and I encourage you to use the Issues list on Github to provide that feedback.

Feel free to fork this repo and to commit your additions. For a list of all contributors, please see the AUTHORS file.

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

Contributing

Fork the repository. Then, run:

git clone --recursive git@github.com:<username>/gittheflow.git
cd gittheflow
git branch master origin/master
git theflow init -d
git theflow topic start <your topic>

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

git theflow topic publish <your topic>

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

License terms

git-theflow is published under the liberal terms of the BSD License, see the LICENSE file. Although the BSD License does not require you to share any modifications you make to the source code, you are very much encouraged and invited to contribute back your modifications to the community, preferably in a Github fork, of course.

Initialization

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

	git theflow init [-d]

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

The -d flag will accept all defaults.

Creating topic/release branches

To list/start/finish topic branches, use:
```
  git theflow topic
  git theflow topic start <name> [<base>]
  git theflow topic finish <name>
```
For topic branches, the <base> arg must be a commit on master.

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

  git theflow topic publish <name>
    git theflow topic pull <remote> <name>

To list/start/finish release branches, use:

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

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

benmcginnis/gittheflow