Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 141 lines (95 sloc) 4.901 kb
877f5fe @nvie Fix placement.
authored
1 git-flow ![Project status](http://stillmaintained.com/nvie/gitflow.png)
6c2d30b @nvie Structurally replace gitflow by git-flow, as a true git extension.
authored
2 ========
12c4ab4 @nvie Update README file to mention new available features.
authored
3 A collection of Git extensions to provide high-level repository operations
4fc0bc1 @nvie Use a more friendly URL for the original blog post URL.
authored
4 for Vincent Driessen's [branching model](http://nvie.com/git-model "original
78c73dc @nvie Add initial project outline and guidelines.
authored
5 blog post").
6
7
553776f @nvie Move up the "getting started" paragraph. It's the most important one
authored
8 Getting started
9 ---------------
10 For the best introduction to get started with `git flow`, please read Jeff
11 Kreeftmeijer's blog post:
12
13 [http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/)
14
15 Or have a look at one of these screen casts:
16
766159d @nvie Add a cool new video tutorial on git-flow by Build a Module.
authored
17 * [How to use a scalable Git branching model called git-flow](http://buildamodule.com/video/change-management-and-version-control-deploying-releases-features-and-fixes-with-git-how-to-use-a-scalable-git-branching-model-called-gitflow) (by Build a Module)
553776f @nvie Move up the "getting started" paragraph. It's the most important one
authored
18 * [A short introduction to git-flow](http://vimeo.com/16018419) (by Mark Derricutt)
19 * [On the path with git-flow](http://codesherpas.com/screencasts/on_the_path_gitflow.mov) (by Dave Bock)
20
21
12c4ab4 @nvie Update README file to mention new available features.
authored
22 Installing git-flow
23 -------------------
07dacd5 @nvie Moved all installation instructions to the Wiki.
authored
24 See the Wiki for up-to-date [Installation Instructions](https://github.com/nvie/gitflow/wiki/Installation).
b17b898 @nvie Add installation note on how to install getopt.
authored
25
78c73dc @nvie Add initial project outline and guidelines.
authored
26
ec0b854 @nvie Add link to git-flow-completion project.
authored
27 Integration with your shell
28 ---------------------------
25def71 @nvie Mention the ZSH support for git-flow-completion.
authored
29 For those who use the [Bash](http://www.gnu.org/software/bash/) or
30 [ZSH](http://www.zsh.org) shell, please check out the excellent work on the
ec0b854 @nvie Add link to git-flow-completion project.
authored
31 [git-flow-completion](http://github.com/bobthecow/git-flow-completion) project
32 by [bobthecow](http://github.com/bobthecow). It offers tab-completion for all
33 git-flow subcommands and branch names.
34
35
11965b3 @nvie Added two FAQs.
authored
36 FAQ
37 ---
61f2c69 @nvie Fix FAQ link.
authored
38 See the [FAQ](http://github.com/nvie/gitflow/wiki/FAQ) section of the project
39 Wiki.
cb92228 @nvie Add FAQ note for Windows users.
authored
40
11965b3 @nvie Added two FAQs.
authored
41
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
42 Please help out
43 ---------------
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
44 This project is still under development. Feedback and suggestions are very
45 welcome and I encourage you to use the [Issues
46 list](http://github.com/nvie/gitflow/issues) on Github to provide that
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
47 feedback.
48
d79a0d4 @nvie Added referral link to the AUTHORS file.
authored
49 Feel free to fork this repo and to commit your additions. For a list of all
50 contributors, please see the [AUTHORS](AUTHORS) file.
78c73dc @nvie Add initial project outline and guidelines.
authored
51
1fd5bcf @nvie Added link to Google group.
authored
52 Any questions, tips, or general discussion can be posted to our Google group:
4d8b379 @nvie Make the links manually.
authored
53 [http://groups.google.com/group/gitflow-users](http://groups.google.com/group/gitflow-users)
1fd5bcf @nvie Added link to Google group.
authored
54
938ea5f @ejholmes Add information for contributing.
ejholmes authored
55 Contributing
56 ------------
49305ec @nvie Rewrote Eric's text a bit.
authored
57 Fork the repository. Then, run:
58
59 git clone --recursive git@github.com:<username>/gitflow.git
60 cd gitflow
61 git branch master origin/master
62 git flow init -d
63 git flow feature start <your feature>
64
65 Then, do work and commit your changes. **Hint**: ``export PATH=`pwd`:$PATH``
66 from within the gitflow directory makes sure you're using the version of
67 gitflow you're currently developing.
68
69 git flow feature publish <your feature>
70
71 When done, open a pull request to your feature branch.
78c73dc @nvie Add initial project outline and guidelines.
authored
72
5d1dbe7 @nvie Added (BSD) licensing terms to the project.
authored
73 License terms
74 -------------
75 git-flow is published under the liberal terms of the BSD License, see the
76 [LICENSE](LICENSE) file. Although the BSD License does not require you to share
77 any modifications you make to the source code, you are very much encouraged and
78 invited to contribute back your modifications to the community, preferably
79 in a Github fork, of course.
80
81
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
82 ### Initialization
78c73dc @nvie Add initial project outline and guidelines.
authored
83
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
84 To initialize a new repo with the basic branch structure, use:
12c4ab4 @nvie Update README file to mention new available features.
authored
85
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
86 git flow init
f9ebb07 @nvie Added 'git flow init' to the README file.
authored
87
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
88 This will then interactively prompt you with some questions on which branches
89 you would like to use as development and production branches, and how you
90 would like your prefixes be named. You may simply press Return on any of
91 those questions to accept the (sane) default suggestions.
92
93
94 ### Creating feature/release/hotfix/support branches
12c4ab4 @nvie Update README file to mention new available features.
authored
95
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
96 * To list/start/finish feature branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
97
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
98 git flow feature
99 git flow feature start <name> [<base>]
100 git flow feature finish <name>
78c73dc @nvie Add initial project outline and guidelines.
authored
101
010252a @nvie Added an optional <base> argument to all start subactions.
authored
102 For feature branches, the `<base>` arg must be a commit on `develop`.
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
103
104 * To list/start/finish release branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
105
04839ae @nvie Forgot list command for hotfixes.
authored
106 git flow release
010252a @nvie Added an optional <base> argument to all start subactions.
authored
107 git flow release start <release> [<base>]
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
108 git flow release finish <release>
78c73dc @nvie Add initial project outline and guidelines.
authored
109
010252a @nvie Added an optional <base> argument to all start subactions.
authored
110 For release branches, the `<base>` arg must be a commit on `develop`.
111
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
112 * To list/start/finish hotfix branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
113
04839ae @nvie Forgot list command for hotfixes.
authored
114 git flow hotfix
010252a @nvie Added an optional <base> argument to all start subactions.
authored
115 git flow hotfix start <release> [<base>]
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
116 git flow hotfix finish <release>
010252a @nvie Added an optional <base> argument to all start subactions.
authored
117
118 For hotfix branches, the `<base>` arg must be a commit on `master`.
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
119
120 * To list/start support branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
121
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
122 git flow support
010252a @nvie Added an optional <base> argument to all start subactions.
authored
123 git flow support start <release> <base>
124
125 For support branches, the `<base>` arg must be a commit on `master`.
78c73dc @nvie Add initial project outline and guidelines.
authored
126
b33ea8a @nvie Added a Flattr button to the README file.
authored
127
128 Showing your appreciation
129 =========================
130 A few people already requested it, so now it's here: a Flattr button.
131
132 Of course, the best way to show your appreciation for the original
133 [blog post](http://nvie.com/git-model) or the git-flow tool itself remains
134 contributing to the community. If you'd like to show your appreciation in
135 another way, however, consider Flattr'ing me:
136
137 [![Flattr this][2]][1]
138
139 [1]: http://flattr.com/thing/53771/git-flow
140 [2]: http://api.flattr.com/button/button-static-50x60.png
Something went wrong with that request. Please try again.