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.2.tar.gz
(17.2 kB
view hashes)
Built Distribution
Close
Hashes for conventional-commit-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cfbff57a1ea184029956d3c7a9293afcaba52b4cfb4725a5568ae0e6842b663 |
|
MD5 | dc02b0514991ce099d86ca3d29fb4515 |
|
BLAKE2b-256 | 18c202ff8e7805f130cf29167c598dc0557deace448dbb486f70ae234482e8b3 |
Close
Hashes for conventional_commit-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49ef38e2b15dccf5df5a12f37468dbebe91b2b634761d2e392befd4cd1f64fd5 |
|
MD5 | 290bf6a96895d339a2213b5ae94e479f |
|
BLAKE2b-256 | 63405478801290d2f21da264d0a405d726e66a12373e13c91b9bb86c0b5cde60 |