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
Built Distribution
Close
Hashes for conventional-commit-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9fd8c968448491b9409f3f7dc16fccac3f52c594c5c6c0c34568e7001b5f17c |
|
MD5 | ab7289cd0df98a23f2d108c6b7ee283c |
|
BLAKE2b-256 | 7bf48a0d14d068223448c1c9b0847b09d8addf20005e9bf272594d21bcdfaef9 |
Close
Hashes for conventional_commit-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7ac8ffe600d51a7fe33b5a4da3bdfbf2449c77d491ea7d652f88d367d46fb95 |
|
MD5 | 786f739d3d178933959ef4108656a961 |
|
BLAKE2b-256 | 3857e136a416f5e4c8f61116621be990bc0ea948b739194422e0459884781a82 |