22
33<img src =" http://assets.avi.io/logo.svg " width =" 300 " />
44
5+ - [ Gong] ( #gong )
6+ - [ Build Status] ( #build-status )
7+ - [ Summary] ( #summary )
8+ - [ Usage] ( #usage )
9+ - [ Installation] ( #installation )
10+ - [ Currently supported clients] ( #currently-supported-clients )
11+ - [ Login] ( #login )
12+ - [ Start working on an issue] ( #start-working-on-an-issue )
13+ - [ ` gong browse ` ] ( #gong-browse )
14+ - [ ` gong comment ` ] ( #gong-comment )
15+ - [ Why a pipe?] ( #why-a-pipe )
16+ - [ ` gong prepare-commit-message ` ] ( #gong-prepare-commit-message )
17+ - [ Install commit hooks on your repository] ( #install-commit-hooks-on-your-repository )
18+ - [ ` gong create ` ] ( #gong-create )
19+ - [ Issues/Feedback] ( #issuesfeedback )
20+ - [ CHANGELOG] ( #changelog )
21+ - [ 1.6.0] ( #160 )
22+ - [ 1.4.0] ( #140 )
23+ - [ 1.3.4] ( #134 )
24+ - [ Upcoming features] ( #upcoming-features )
25+ - [ ` gong slack ` ] ( #gong-slack )
26+ - [ ` gong next/pick ` ] ( #gong-nextpick )
27+ - [ Development] ( #development )
528### Build Status
629
730* Develop: ![ Build Status] ( https://travis-ci.org/KensoDev/gong.svg?branch=develop )
@@ -45,6 +68,20 @@ Once you input all of the details the client will attempt to login. If succeeded
4568
4669[ ![ asciicast] ( https://asciinema.org/a/dcko3kv5xwobpf4rgj0e4ulyo.png )] ( https://asciinema.org/a/dcko3kv5xwobpf4rgj0e4ulyo )
4770
71+ You can also define ` ~/.gong.json ` :
72+
73+ {
74+ "client":"jira",
75+ "domain":"<JIRA_DOMAIN>",
76+ "password":"<JIRA_API_TOKEN>",
77+ "project_prefix":"<PROJECT_PREFIX>",
78+ "transitions":"In Progress",
79+ "username":"<JIRA_EMAIL>"
80+ }
81+
82+ NOTE:
83+ For Passowrd get an API Token.
84+ https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
4885### Start working on an issue
4986
5087` gong start {issue-id} --type feature `
@@ -59,6 +96,10 @@ This will do a couple of things
5996
6097[ ![ asciicast] ( https://asciinema.org/a/c5libsysjmb5f8f8gizkbldzv.png )] ( https://asciinema.org/a/c5libsysjmb5f8f8gizkbldzv )
6198
99+ NOTE:
100+ You can define a default (branch) type with env var:
101+
102+ echo "export GONG_DEFAULT_BRANCH_TYPE=story" >> ~/.zshrc
62103### ` gong browse `
63104
64105While working on a branch that matches the gong regular expression (look
@@ -138,3 +179,18 @@ Send a message to a slack channel, tagging the issue you are working on
138179
139180Show you the next items on your backlog, be able to start one without opening the browser
140181
182+ ## Development
183+ Update version:
184+
185+ go get
186+
187+ Build:
188+
189+ cd cmd/gong/
190+ ./build.sh
191+
192+ Add gong to your PATH and restart SEHLL, e.g.:
193+
194+ mv gong /usr/local/bin/gong
195+ exec $SHELL
196+
0 commit comments