Keep a Changelog .com? - Githubissues

kornelski / cargo-deb

Make Debian packages directly from Rust/Cargo projects

https://lib.rs/cargo-deb

MIT License

431 stars 52 forks source link

Keep a Changelog .com? #147

Closed dcampbell24 closed 2 weeks ago

dcampbell24 commented 1 month ago

Maybe you should follow https://keepachangelog.com/en/1.0.0/ because it is a standard and it would suggest making your changelog correct markdown. Currently, you have some style errors like more than one top level item (#) and indented lists.

orhun commented 1 month ago

Additionally, if you ever want to automatically generate the changelog, you can check out git-cliff 🐻 (supports keepachangelog)

example config: https://github.com/orhun/git-cliff/blob/main/examples/github.toml
example output: https://github.com/orhun/git-cliff/blob/main/CHANGELOG.md

kornelski commented 2 weeks ago

Sorry, I don't like the git-cliff commit message style. Changelog is a chore for me that I don't like, and keep forgetting about it. Automated changelog won't be smarter than what commits say, so I encourage you to check the commit history.