From d1e6dad31889646fcbd94ed0ba19aea8077a32d4 Mon Sep 17 00:00:00 2001 From: falko-apheris <86360866+falko-apheris@users.noreply.github.com> Date: Fri, 13 Aug 2021 14:32:22 +0200 Subject: [PATCH] docs: add docs for 3rd party module cz-github-jira-conventional --- docs/third-party-commitizen.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/third-party-commitizen.md b/docs/third-party-commitizen.md index 7c27e75d8..ff6144e6b 100644 --- a/docs/third-party-commitizen.md +++ b/docs/third-party-commitizen.md @@ -11,6 +11,17 @@ meaningful way. It can be installed with `pip install conventional-JIRA`. +### [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 the CHANGELOG.md +- creating links to JIRA issues in the CHANGELOG.md + +It can be installed with `cz-github-jira-conventional`. + +For installation instructions (configuration and pre-commit) please visit https://github.com/apheris/cz-github-jira-conventional + ### [Commitizen emoji](https://pypi.org/project/commitizen-emoji/) Just like *conventional commit* format, but with emojis and optionally time spent and related tasks.