Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

better docs for jira plugin #1811

Merged
merged 1 commit into from Feb 15, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 8 additions & 1 deletion 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

Expand Down