浏览代码

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

Robby Russell 2 年之前
父节点
当前提交
046f0ca557
共有 1 个文件被更改,包括 25 次插入21 次删除
  1. 25 21
      plugins/jira/README.md

+ 25 - 21
plugins/jira/README.md

@@ -14,27 +14,31 @@ In this document, "JIRA" refers to the JIRA issue tracking server, and `jira` re
 
 
 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.
 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.
 
 
-```
-jira            # performs the default action
-
-jira new        # opens a new issue
-jira dashboard [rapid_view]  # opens your JIRA dashboard
-jira mine       # queries for your own issues
-jira tempo      # opens your JIRA Tempo
-jira reported [username]  # queries for issues reported by a user
-jira assigned [username]  # queries for issues assigned to a user
-jira branch     # opens an existing issue matching the current branch name
-                # The branch name may have prefixes ending in "/": "feature/MP-1234",
-                # and also suffixes starting with "_": "MP-1234_fix_dashboard"
-                # In both these cases, the issue opened will be "MP-1234"
-                # This is also checks if the prefix is in the name, and adds it if not, so:
-                # "MP-1234" opens the issue "MP-1234",
-                # "mp-1234" opens the issue "mp-1234",
-                # and "1234" opens the issue "MP-1234".
-# NOTE: since jira is case insensitive, the first two examples open the same issue
-jira ABC-123    # opens an existing issue
-jira ABC-123 m  # opens an existing issue for adding a comment
-```
+## Commands
+
+| Command       | Description                                               |
+| :------------ | :-------------------------------------------------------- |
+| `jira`        | Performs the default action                               |
+| `jira new`    | Opens a new Jira issue dialogue                           |
+| `jira ABC-123`   | Opens an existing issue                                |
+| `jira ABC-123 m` | Opens an existing issue for adding a comment           |
+| `jira dashboard [rapid_view]` |  # opens your JIRA dashboard              |
+| `jira mine`   | Queries for your own issues                               |
+| `jira tempo`  | Opens your JIRA Tempo                                     |
+| `jira reported [username]`  | Queries for issues reported by a user       |
+| `jira assigned [username]`  | Queries for issues assigned to a user       |
+| `jira branch` | Opens an existing issue matching the current branch name  |
+
+
+### Jira Branch usage notes
+
+The branch name may have prefixes ending in "/": "feature/MP-1234", and also suffixes 
+starting with "_": "MP-1234_fix_dashboard". In both these cases, the issue opened will be "MP-1234"
+
+This is also checks if the prefix is in the name, and adds it if not, so: "MP-1234" opens the issue "MP-1234",
+"mp-1234" opens the issue "mp-1234", and "1234" opens the issue "MP-1234".
+
+
 
 
 #### Debugging usage  ####
 #### Debugging usage  ####