Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
martyzz1 committed Feb 16, 2022
1 parent 0f49368 commit d10a9f7
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
===========
============
git features
===========
============

git helper scripts for managing feature branches and issuing pull requests

************
Installation
************

::

$ pip install git+git://github.com/robinedwards/gitfeatures.git

Install for development:

::

$ git clone git://github.com/robinedwards/gitfeatures.git
$ cd gitfeatures
$ pip install -r requirements-dev.txt
$ pre-commit install
$ python setup.py develop

*************
Expand Down Expand Up @@ -42,7 +48,7 @@ These scripts are designed to follow the github git work flow http://scottchacon
Features
********

Create a new feature (create a new local and remote branch prefixed 'feature_')
Create a new feature (create a new local and remote branch prefixed 'feature')

$ git feature new html_pruning

Expand All @@ -60,13 +66,13 @@ Or if your not currently working on the feature branch

Or if you wish to create a stable branch from a specific checkout

$ git stable new
$ git stable|hotfix|release new

will create a branch called stable_YYYYMMDD
will create a branch called stable|hotfix|release_YYYYMMDD

Or if you wish to switch to the current latest stable branch
Or if you wish to switch to the current latest stable|hotfix|release branch

$ git stable
$ git stable|hotfix|release

*********
Hot fixes
Expand Down

0 comments on commit d10a9f7

Please sign in to comment.