diff --git a/index.html b/index.html index a2f7d33..1451d39 100644 --- a/index.html +++ b/index.html @@ -6,8 +6,8 @@ git-flow cheatsheet - - + + @@ -80,28 +80,31 @@

Setup

- + +

★ ★ ★

OSX

- $ brew install git-flow + $ brew install git-flow

Linux

- $ apt-get install git-flow + $ apt-get install git-flow

Windows (Cygwin)

- $ wget -q -O - --no-check-certificate - https://github.com/nvie/gitflow/raw/develop/contrib/gitflow-installer.sh | bash + $ wget -q -O - --no-check-certificate + https://github.com/nvie/gitflow/raw/develop/contrib/gitflow-installer.sh | bash

- You need a working git installation as prerequirement.
- For detailed instructions please visit the git flow + For detailed git flow intallation instructions please visit the git flow wiki.

install git-flow @@ -110,15 +113,14 @@

Getting started

- +

Git flow needs to be initialized in order to customize your project setup.

+

★ ★ ★

Initialize

Start using git-flow by initializing it inside an existing git repository:

- - git flow init - + git flow init

You'll have to answer a few questions regarding the naming conventions for your branches.
@@ -137,21 +139,19 @@

Features

+
  • Develop new features for upcoming releases
  • Typically exist in developers repos only
+

★ ★ ★

Start a new feature

-

Development of new features starting from the 'develop' branch.

-

Start developing a new feature with

- git-flow feature start MYFEATURE -

This action creates a new feature branch based on 'develop' and switches to it

@@ -186,9 +186,7 @@
- - git-flow feature finish MYFEATURE - + git-flow feature finish MYFEATURE
@@ -206,9 +204,7 @@

- - git-flow feature publish MYFEATURE - + git-flow feature publish MYFEATURE
@@ -225,9 +221,7 @@

- - git-flow feature pull MYFEATURE - + git-flow feature pull MYFEATURE
@@ -243,7 +237,7 @@
  • Support preparation of a new production release
  • Allow for minor bug fixes and preparing meta-data for a release
  • - +

    ★ ★ ★

    Start a release

    @@ -251,9 +245,7 @@ creates a release branch created from the 'develop' branch.

    - - git flow release start RELEASE [BASE] - + git flow release start RELEASE [BASE]

    You can optionally supply a [BASE] commit sha-1 hash to start the release from. The commit must be on the @@ -276,17 +268,13 @@

  • Removes the release branch
  • - - git flow release finish RELEASE - + git flow release finish RELEASE

    It's wise to publish a finished release after finishing it. Do it similar to feature publishing with the command:

    - - git flow release publish RELEASE - + git flow release publish RELEASE

    (You can track a remote release with the
    git flow release track RELEASE command)

    @@ -304,15 +292,13 @@
  • May be branched off from the corresponding tag on the master branch that marks the production version.
  • - +

    ★ ★ ★

    git flow hotfix start

    Like the other git flow commands, a hotfix is started with

    - - git flow hotfix start RELEASE - + git flow hotfix start RELEASE

    The release argument hereby marks the faulty production release

    @@ -343,6 +329,7 @@

    Backlog

    +

    ★ ★ ★

    • Not all available commands are covered here, only the most important ones
    • You can still use git and all its commands normally as you know them, git flow is only a tooling @@ -350,6 +337,7 @@
    • The 'support' feature is still beta, using it is not advised
    +

    ★ ★ ★