Merge pull request #1811 from intuit/jira-docs

better docs for jira plugin
intuit · Feb 15, 2021 · 8d90c41 · 8d90c41
2 parents 0594471 + b46cac1
commit 8d90c41
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/plugins/jira/README.md b/plugins/jira/README.md
@@ -1,6 +1,13 @@
 # Jira Plugin
 
-To include Jira story information in your changelogs you must include a URL to your hosted JIRA instance.
+Include links to Jira stories in your changelogs.
+
+This plugin will create links to Jira stories using the following syntax in a pull request title:
+
+```txt
+JIRA-123: My pull request title
+[JIRA-123]: My pull request title
+```
 
 ## Installation