-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
23419b4
commit a50f103
Showing
1 changed file
with
79 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,81 @@ | ||
| # GoBranch | ||
| [](https://github.com/ipanardian/gobranch/issues) | ||
| [](https://github.com/ipanardian/gobranch/releases) | ||
| [](https://github.com/ipanardian/gobranch/releases) | ||
| [](https://gitter.im/ipanardian/gobranch) | ||
| [](https://github.com/ipanardian/GoBranch/blob/master/LICENSE) | ||
| [](https://github.com/ipanardian/GoBranch) | ||
|
|
||
|
|
||
|
|
||
| A command line app to help you quickly creating git branch without hassle step. | ||
|
|
||
| ## Usage | ||
| ``` | ||
| $ gobranch | ||
| ``` | ||
|  | ||
|
|
||
| ## Custom | ||
|  | ||
|
|
||
| ## Features | ||
| * You don't need to type a valid branch name | ||
| * You don't need to checkout to the base branch | ||
| * You don't need to git pull the base branch | ||
| * Automatic prefixes such as feature, enhance, bugfix, hotfix | ||
| * Prevent the selected base branch from being wrong | ||
| * Custom base branch | ||
| * Custom naming conventions | ||
|
|
||
| ## Requirements | ||
| * Git | ||
|
|
||
| ## Installation | ||
| ``` | ||
| $ go get github.com/ipanardian/GoBranch | ||
| ``` | ||
| or just download the binary file on the release tab and add it to your ***$PATH*** or save it to ***/usr/local/bin***. | ||
|
|
||
| ## Naming Conventions | ||
| ``` | ||
| $ gobranch --tc "/" --nc "snake" | ||
| //output: feature/abcd_efgh | ||
| $ gobranch --tc "-" --nc "kebab" | ||
| //output: feature-abcd-efgh | ||
| ``` | ||
|
|
||
| ## Branch Tree | ||
| The following is a branch of the gobranch diagram, you must have a branch **development** and **hotfix**, unless you choose **custom** then there is no need to follow this diagram. | ||
| ``` | ||
| -- master | ||
| |-- development | ||
| | |-- feature_{name} | ||
| | |-- enhance_{name} | ||
| | |-- bugfix_{name} | ||
| | `-- test_{name} | ||
| `-- hotfix | ||
| |-- hotfix_{name} | ||
| `-- hotfeature_{name} | ||
| ``` | ||
|
|
||
| ## Flags | ||
| ``` | ||
| //show help | ||
| $ gobranch --help or -h | ||
| //show version | ||
| $ gobranch --version or -v | ||
| //Set type convention | ||
| $ gobranch --tc / | ||
| //output: feature/{branch} | ||
| //Set naming convention | ||
| $ gobranch --nc kebab | ||
| //output: branch-name | ||
| ``` | ||
|
|
||
| ## License | ||
| The MIT License (MIT) |