Skip to content

O
oh-my-zsh
Unverified Commit 046f0ca5 authored by Robby Russell's avatar Robby Russell Committed by GitHub
Browse files
Options

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

parent 2c2187b0
Show whitespace changes
Inline Side-by-side
Showing with 25 additions and 21 deletions
plugins/jira/README.md
View file @ 046f0ca5
...@@ -14,27 +14,31 @@ In this document, "JIRA" refers to the JIRA issue tracking server, and `jira` re ...@@ -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.
``` ## Commands
jira # performs the default action
| Command | Description |
jira new # opens a new issue | :------------ | :-------------------------------------------------------- |
jira dashboard [rapid_view] # opens your JIRA dashboard | `jira` | Performs the default action |
jira mine # queries for your own issues | `jira new` | Opens a new Jira issue dialogue |
jira tempo # opens your JIRA Tempo | `jira ABC-123` | Opens an existing issue |
jira reported [username] # queries for issues reported by a user | `jira ABC-123 m` | Opens an existing issue for adding a comment |
jira assigned [username] # queries for issues assigned to a user | `jira dashboard [rapid_view]` | # opens your JIRA dashboard |
jira branch # opens an existing issue matching the current branch name | `jira mine` | Queries for your own issues |
# The branch name may have prefixes ending in "/": "feature/MP-1234", | `jira tempo` | Opens your JIRA Tempo |
# and also suffixes starting with "_": "MP-1234_fix_dashboard" | `jira reported [username]` | Queries for issues reported by a user |
# In both these cases, the issue opened will be "MP-1234" | `jira assigned [username]` | Queries for issues assigned to a user |
# This is also checks if the prefix is in the name, and adds it if not, so: | `jira branch` | Opens an existing issue matching the current branch name |
# "MP-1234" opens the issue "MP-1234",
# "mp-1234" opens the issue "mp-1234",
# and "1234" opens the issue "MP-1234". ### Jira Branch usage notes
# NOTE: since jira is case insensitive, the first two examples open the same issue
jira ABC-123 # opens an existing issue The branch name may have prefixes ending in "/": "feature/MP-1234", and also suffixes
jira ABC-123 m # opens an existing issue for adding a comment 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 ####
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment