Skip to content

Commit 44233a1

Browse files
committed
Updated doc
1 parent 0aa0796 commit 44233a1

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,26 +48,28 @@ jobs:
4848
4949
# Usage
5050
51-
In "auto" mode the workflow is:
51+
This app can support your development workflow in two ways (modes): auto and chatops.
52+
53+
In "auto" mode the typical development workflow is:
5254
5355
1. An issue is created, for example: Issue 15: Fix nasty bug!
5456
5557
*some time may pass*
5658
5759
2. The issue is assigned
5860
3. When the issue is assigned this app will create a new issue branch
59-
(for the example issue this branch will be called `issue-15-Fix_nasty_bug`.) If the issue is re-assigned no new branch will be created.
61+
(for the example issue this branch will be called `issue-15-Fix_nasty_bug`)
6062

61-
In "chatops" mode the workflow is:
63+
In "chatops" mode the typical development workflow is:
6264

6365
1. An issue is created, for example: Issue 15: Fix nasty bug!
6466

6567
*some time may pass*
6668

6769
2. A developer that wants to work on this issue gives the ChatOps command `/cib` as a comment on the issue
6870
3. This app will create a new issue branch
69-
(for the example issue this branch will be called `issue-15-Fix_nasty_bug`.)
70-
By default the app notifies creation is completed with a comment on the issue. If the branch already exists no new branch will be created.
71+
(for the example issue this branch will be called `issue-15-Fix_nasty_bug`)
72+
By default the app notifies creation is completed with a comment on the issue.
7173

7274
# Configuration
7375

0 commit comments

Comments
 (0)