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.3.tar.gz
(17.2 kB
view hashes)
Built Distribution
Close
Hashes for conventional-commit-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d30b1e2904a2f3b8b887380226ffce36defcd3d3c902dbfbebe2a83472f8446 |
|
MD5 | 5e67eded7277d7778c93d0a90ea5cf6b |
|
BLAKE2b-256 | 1dce4c9c58672d1fc3531aa74b7662ad6144cbd7306b02e2689d060b0c1ba2fe |
Close
Hashes for conventional_commit-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b48f8b5564f9a8ade3480335f9999ccb0c65ce236c90a893c844631249f412e9 |
|
MD5 | 0340b9975dfa9c6428da5de311498c25 |
|
BLAKE2b-256 | 8fd6d747de1e6bf0e3c992163ae69d66da32670123f7d9ba74e21bb8e9932b2b |