Show Menu
Cheatography

gitchangelog Cheat Sheet by

Personal implementation for gitchangelog

KEEP A CHANGELOG

Concept

Why
keepac­han­gel­og.com
What
How
.gitch­ang­elog.rc repository
GIT Tag
[0-9]+­\.[­0-9­]+(­\.[­0-9­]+)­?(-.+.­)?­(\+.+.)?
Tag examples
1.3.0; 1.1.2-­beta1; 1.0.0-­bet­a.3­+bu­ild.20.f4­2cbd56
Date
(2017-­08-11)
Sample result
2.1.1 (2014-­04-15)

Format

ACTION: [AUDIE­NCE:] COMMIT_MSG [!TAG ...]
 

ACTION

new:
for new features, big improv­ement
chg:
for refactor, small improv­ement, cosmetic changes...
fix:
for bug fixes

AUDIENCE

dev:
for develo­ppers (API changes, refact­ors...)
usr: or user:
for final users (UI changes)
pkg:
packaging changes
test:
test only related changes
doc:
doc only changes

TAG

!ref­actor
for refact­oring code only
!minor
for a very meanin­gless change (a typo, adding a comment)
!cos­metic
for cosmetic driven change (re-in­den­tation, 80-col...)
!wip
for partial functi­onality but complete subfun­cti­onality

Examples de message

new: usr: support of bazaar implem­ented
chg: re-ind­entend some lines !cos­metic
fix: pkg: updated year of licence coverage.
new: test: added a bunch of test around user usability of feature X.
fix: typo in spelling my name in comment. !minor

Help Us Go Positive!

We offset our carbon usage with Ecologi. Click the link below to help us!

We offset our carbon footprint via Ecologi
 

Comments

No comments yet. Add yours below!

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.