a tool for writing conventional commits, conveniently
Project description
gitcommit
a tool for writing conventional commits, conveniently
Install
To install
pip install conventional-commit
To use, run the following command from within a git repository
gitcommit
Overview
The purpose of this utility is to expedite the process of committing with a conventional message format in a user friendly way. This tool is not templated, because it sticks rigidly to the Conventional Commit standard, and thus not designed to be 'altered' on a case by case basis.
Commit messages produced follow the general template:
<type>[(optional scope)]: <description>
[BREAKING CHANGE: ][optional body / required if breaking change]
[optional footer]
Additional rules implemeted:
- Subject line (i.e. top) should be no more than 50 characters.
- Every other line should be no more than 72 characters.
- Wrapping is allowed in the body and footer, NOT in the subject.
Development
For development, see the developer readme file: README.dev.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
conventional-commit-0.0.6.tar.gz
(17.2 kB
view hashes)
Built Distribution
Close
Hashes for conventional-commit-0.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8300ecd3f365e7ec9741d66e911bdc06ee2b8a5447fca91b0beea5734611273d |
|
MD5 | 94a23964b2f83090073318f82855c476 |
|
BLAKE2b-256 | 93767b20974e0a83208f75d27cd89557d334e306f197266a369b2d9e6a9724a3 |
Close
Hashes for conventional_commit-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 928ed10d0a0208d1172e11520022588f93914c80fe67f57878f6f064e9e01f54 |
|
MD5 | 2c12f752e394fdcbe03addb3f0d1e64f |
|
BLAKE2b-256 | 76ce13898a24f5169957d119740e241ec16032c28b628199e437e0ab64f69849 |