Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(Doc) Beginner's guide #87

Open
rieschl opened this issue Sep 10, 2020 · 0 comments
Open

(Doc) Beginner's guide #87

rieschl opened this issue Sep 10, 2020 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@rieschl
Copy link

rieschl commented Sep 10, 2020

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
  • git commit/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 :)

@rieschl rieschl added the enhancement New feature or request label Sep 10, 2020
@weierophinney weierophinney added the help wanted Extra attention is needed label Sep 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants