Python 3 command line utility to standardize commit messages
This client tool prompts the user with information about the commit.
Based on conventional commits
pip install commitizen
Run in your terminal
cz commit
or the shortcut
cz c
usage: cz [-h] [--debug] [-n NAME] {all,commit,c,example,info,schema} ...
Commitizen is a python cli tool to generate conventional commits.
For more information about the topic go to https://conventionalcommits.org/
optional arguments:
-h, --help show this help message and exit
--debug use debug mode
-n NAME, --name NAME use the given commitizen
commands:
{all,commit,c,example,info,schema}
all show available commitizens
commit (c) create new commit
example show commit example
info show information about the cz
schema show commit schema
You can create in your project folder a file called .cz, .cz.cfg or in your setup.cfg
or if you want to configure the global default in your user's home folder a .cz file
with the following information:
[commitizen] name = cz_angular
Create a file starting with cz_ for example cz_jira.py.
This prefix is used to detect the plugin. Same method flask uses
Inherit from BaseCommitizen and you must define questions
and message. The others are optionals.
from commitizen import BaseCommitizen
class JiraCz(BaseCommitizen):
def questions(self):
"""Questions regarding the commit message.
Must have 'whaaaaat' format.
More info: https://github.com/finklabs/whaaaaat/
:rtype: list
"""
questions = [
{
'type': 'input',
'name': 'title',
'message': 'Commit title'
},
{
'type': 'input',
'name': 'issue',
'message': 'Jira Issue number:'
},
]
return questions
def message(self, answers):
"""Generate the message with the given answers.
:type answers: dict
:rtype: string
"""
return '{0} (#{1})'.format(answers['title'], answers['issue'])
def example(self):
"""Provide an example to help understand the style (OPTIONAL)
Used by cz example.
:rtype: string
"""
return 'Problem with user (#321)'
def schema(self):
"""Show the schema used (OPTIONAL)
:rtype: string
"""
return '<title> (<issue>)'
def info(self):
"""Explanation of the commit rules. (OPTIONAL)
:rtype: string
"""
return 'We use this because is useful'
discover_this = JiraCz # used by the plugin systemThe next file required is setup.py modified from flask version
from distutils.core import setup
setup(
name='JiraCommitizen',
version='0.1.0',
py_modules=['cz_jira'],
license='MIT',
long_description='this is a long description',
install_requires=['commitizen']
)So at the end we would have
. ├── cz_jira.py └── setup.py
And that's it, you can install it without uploading to pypi by simply doing
pip install . If you feel like it should be part of the repo, create a
PR.
- [ ] auto changelog integration
- [ ] tests