51 lines
996 B
Markdown
51 lines
996 B
Markdown
### Installation
|
|
|
|
clone the repository
|
|
|
|
```
|
|
mkdir -p ~/GitHub/rkiel
|
|
git clone git@github.com:rkiel/git-feature.git
|
|
```
|
|
|
|
add the bin to your path
|
|
|
|
```
|
|
export PATH=~/GitHub/rkiel/git-feature/bin:$PATH
|
|
```
|
|
|
|
### Usage
|
|
|
|
This utility is built around some standard branch names: `master`, `develop`, and `integration`.
|
|
|
|
Feature branches have specific format: USER-BASE-FEATURE.
|
|
|
|
* USER is the username as specificied by the USER environment variable
|
|
* BASE is the branch to base the feature branch on
|
|
* FEATURE is the name of the feature
|
|
|
|
#### Start
|
|
|
|
To start a new feature, go to one of the standard branches.
|
|
|
|
```
|
|
git checkout master
|
|
```
|
|
|
|
Use the `start` subcommand with a feature name.
|
|
|
|
```
|
|
feature start my-new-feature
|
|
```
|
|
|
|
For example, a new branch will be created called `rkiel-master-my-new-feature`
|
|
|
|
#### End
|
|
|
|
Use the `end` subcommand to close out the feature.
|
|
|
|
```
|
|
feature end
|
|
```
|
|
|
|
For example, the feature branch `rkiel-master-my-new-feature` will be deleted the `master` will be checked out.
|