Cheatography
https://cheatography.com
Personal implementation for gitchangelog
Concept
Why |
keepachangelog.com |
What |
|
How |
.gitchangelog.rc repository |
GIT Tag |
[0-9]+\.[0-9]+(\.[0-9]+)?(-.+.)?(\+.+.)? |
Tag examples |
1.3.0; 1.1.2-beta1; 1.0.0-beta.3+build.20.f42cbd56 |
Date |
(2017-08-11) |
Sample result |
2.1.1 (2014-04-15) |
Format
ACTION: [AUDIENCE:] COMMIT_MSG [!TAG ...] |
|
|
ACTION
new: |
for new features, big improvement |
chg: |
for refactor, small improvement, cosmetic changes... |
fix: |
for bug fixes |
AUDIENCE
dev: |
for developpers (API changes, refactors...) |
usr: or user: |
for final users (UI changes) |
pkg: |
packaging changes |
test: |
test only related changes |
doc: |
doc only changes |
TAG
!refactor |
for refactoring code only |
!minor |
for a very meaningless change (a typo, adding a comment) |
!cosmetic |
for cosmetic driven change (re-indentation, 80-col...) |
!wip |
for partial functionality but complete subfunctionality |
Examples de message
new: usr: support of bazaar implemented |
chg: re-indentend some lines !cosmetic |
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 |
|
Created By
Metadata
Favourited By
Comments
No comments yet. Add yours below!
Add a Comment