046f0ca5571e28aa328566d5f81a338e074cf174

Author
Robby Russell <robby@planetargon.com>
Committer
GitHub <noreply@github.com>
Date

Message

fix(jira): Update README examples to a table format

Diff

 1diff --git a/plugins/jira/README.md b/plugins/jira/README.md
 2index 5dc5bfc9697c412928cc7fed9258b2a402ea8c9b..d78ea15a45e74a589519c44748ffaf7e317be0f5 100644
 3--- a/plugins/jira/README.md
 4+++ b/plugins/jira/README.md
 5@@ -14,27 +14,31 @@ In this document, "JIRA" refers to the JIRA issue tracking server, and `jira` re
 6 
 7 This plugin supplies one command, `jira`, through which all its features are exposed. Most forms of this command open a JIRA page in your web browser.
 8 
 9-```
10-jira            # performs the default action
11-
12-jira new        # opens a new issue
13-jira dashboard [rapid_view]  # opens your JIRA dashboard
14-jira mine       # queries for your own issues
15-jira tempo      # opens your JIRA Tempo
16-jira reported [username]  # queries for issues reported by a user
17-jira assigned [username]  # queries for issues assigned to a user
18-jira branch     # opens an existing issue matching the current branch name
19-                # The branch name may have prefixes ending in "/": "feature/MP-1234",
20-                # and also suffixes starting with "_": "MP-1234_fix_dashboard"
21-                # In both these cases, the issue opened will be "MP-1234"
22-                # This is also checks if the prefix is in the name, and adds it if not, so:
23-                # "MP-1234" opens the issue "MP-1234",
24-                # "mp-1234" opens the issue "mp-1234",
25-                # and "1234" opens the issue "MP-1234".
26-# NOTE: since jira is case insensitive, the first two examples open the same issue
27-jira ABC-123    # opens an existing issue
28-jira ABC-123 m  # opens an existing issue for adding a comment
29-```
30+## Commands
31+
32+| Command       | Description                                               |
33+| :------------ | :-------------------------------------------------------- |
34+| `jira`        | Performs the default action                               |
35+| `jira new`    | Opens a new Jira issue dialogue                           |
36+| `jira ABC-123`   | Opens an existing issue                                |
37+| `jira ABC-123 m` | Opens an existing issue for adding a comment           |
38+| `jira dashboard [rapid_view]` |  # opens your JIRA dashboard              |
39+| `jira mine`   | Queries for your own issues                               |
40+| `jira tempo`  | Opens your JIRA Tempo                                     |
41+| `jira reported [username]`  | Queries for issues reported by a user       |
42+| `jira assigned [username]`  | Queries for issues assigned to a user       |
43+| `jira branch` | Opens an existing issue matching the current branch name  |
44+
45+
46+### Jira Branch usage notes
47+
48+The branch name may have prefixes ending in "/": "feature/MP-1234", and also suffixes 
49+starting with "_": "MP-1234_fix_dashboard". In both these cases, the issue opened will be "MP-1234"
50+
51+This is also checks if the prefix is in the name, and adds it if not, so: "MP-1234" opens the issue "MP-1234",
52+"mp-1234" opens the issue "mp-1234", and "1234" opens the issue "MP-1234".
53+
54+
55 
56 #### Debugging usage  ####
57