File: github-jira-conventional.md

package info (click to toggle)
commitizen 4.10.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,892 kB
  • sloc: python: 17,728; makefile: 15
file content (17 lines) | stat: -rw-r--r-- 564 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
 
# [GitHub JIRA Conventional](https://pypi.org/project/cz-github-jira-conventional/)

This plugin extends the Commitizen tools by:

- requiring a JIRA issue ID in the commit message
- creating links to GitHub commits in `CHANGELOG.md`
- creating links to JIRA issues in `CHANGELOG.md`

<!-- TODO: What features does the plugin provide? -->

## Installation

```sh
pip install cz-github-jira-conventional
```

For installation instructions (configuration and pre-commit), please visit the [GitHub repository](https://github.com/apheris/cz-github-jira-conventional).