(Doc) Beginner's guide
rieschl opened this issue · comments
Feature Request
| Q | A |
|---|---|
| New Feature | yes |
| BC Break | no |
Summary
The first time I used KAC I had to figure out how a regular flow would look like. I got used to it quite quickly but a small tutorial would have been helpful. Something like that:
Basic flow for a bugfix:
- create a changelog:
keep-a-changelog changelog:new - add a new patch release:
keep-a-changelog bump - fix the bug in the code
- log the stuff in the changelog:
keep-a-changelog entry:changed -- "Fix that nasty bug" - when you're ready to merge/release:
keep-a-changelog version:ready gitcommit/push/merge/...- tag the version:
keep-a-changelog version:tag 1.2.3 - release the version:
keep-a-changelog version:release 1.2.3
It'd really speed up getting used to KAC.
Thanks :)