diff --git a/Cargo.toml b/Cargo.toml index 65fbc78..47299ff 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "changelog-rs" -version = "0.3.0" +version = "0.3.1" authors = ["Per Lundberg "] description = "Generates CHANGELOG.md files based on git commit and tag information." license = "MIT" diff --git a/README.md b/README.md index bcfd2ef..1a1c061 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ # changelog-rs -Trivial Rust-based CHANGELOG.md generation tool. The program uses git metadata (tags and commit messages) to generate the +Trivial Rust-based CHANGELOG.md generation tool. + +The program uses git metadata (tags and commit messages) to generate the changelog. Works especially well if you use the "squash on merge" or "rebase on merge" flow [on GitHub](https://help.github.com/articles/about-merge-methods-on-github/). The former is for when you want to squash _all_ commits in a feature branch into a single commit on the base branch on merge, the latter is when you perhaps already have been @@ -11,7 +13,7 @@ different bugs, or whatever). The tool do _not_ work well if you use the "traditional" merge mode, where all PR merges retain their individual commits _and_ adds an extra "merge commit" that (to me) does not add any value at all, apart from cluttering the revision history. I strongly -discourage anyone from using this merge mode, it forces all other people working on the project to see a revision history with a +discourage anyone from using this merge mode; it forces all other people working on the project to see a revision history with a lot more details which are in the long run pretty useless. You care about _what_ the change was and _who_ did it. If you need more details than that, the GitHub web interface gives you more details (like, the discussion that took place within the PR and the history of how it looked like before merging, including the individual commits).