From e71061a2e4a46456d2d67c47072bb58d0942f1eb Mon Sep 17 00:00:00 2001 From: Michael Kuc Date: Fri, 24 Apr 2020 09:49:45 +0100 Subject: [PATCH] docs(third-party): add third-party template documentation Add a new docs section for third-party contributed commit templates. This way new templates do not need to be merged into the main codebase, and instead exist as satellite repositories. See #158 for motivation. --- docs/README.md | 4 ++++ docs/third-party-commitizen.md | 12 ++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 docs/third-party-commitizen.md diff --git a/docs/README.md b/docs/README.md index c3f94ccf64..cdeef31a76 100644 --- a/docs/README.md +++ b/docs/README.md @@ -102,6 +102,10 @@ commands: init init commitizen configuration ``` +## Third-Party Commitizen Templates + +See [docs/third-party-commitizen.md](third-party-commitizen.md). + ## FAQ ### Why are `revert` and `chore` valid types in the check pattern of cz conventional_commits but not types we can select? diff --git a/docs/third-party-commitizen.md b/docs/third-party-commitizen.md new file mode 100644 index 0000000000..0b09f015cf --- /dev/null +++ b/docs/third-party-commitizen.md @@ -0,0 +1,12 @@ +## Third-Party Commitizen Templates + +In addition to the native templates, some alternative commit format templates +are available as PyPI packages (installable with `pip`). + +### [Conventional JIRA](https://pypi.org/project/conventional-JIRA/) + +Just like *conventional commit* format, but the scope has been restricted to a +JIRA issue format, i.e. `project-issueNumber`. This standardises scopes in a +meaningful way. + +It can be installed with `pip install conventional-JIRA`.