README.md in pr_changelog-0.1.0 vs README.md in pr_changelog-0.1.1

- old
+ new

@@ -1,9 +1,25 @@ # PR Changelog -A script to generate a nice list of changes given two git references. +A script to generate a nice list of changes given two git references, like so: +```markdown +## Changes since 0.3.0 to 0.5.0 + +[New features] + - #61: ⭐️ Shake the phone to send feedback email + +[Improvements] + - #64: 💎 Visual refinements for canvas 2.0 + - #57: 💎 Memory performance tweaks + - #62: 💎 Visual polishing for top stories + +[Internal] + - #65: 👨‍💻 Add formatting rules for xml files + - #60: 👨‍💻 Setup hockeyapp for crash reporting +``` + It takes in account all the merged pull request to master between the two given references, then it formats it in a nice consumable way. To be effective, this script requires that you follow simple conventions: 1. Your pull request titles must be written as changelog entries @@ -40,10 +56,30 @@ ``` $ pr_changelog 0.3.0 0.5.0 ``` +Will produce something like: + +```markdown +## Changes from 0.3.0 to 0.5.0 + +- #64: Improvement: visual refinements for canvas 2.0 +- #65: Internal: add formatting rules for xml files +- #63: Feature: add Footer story +- #57: Improvement: memory performance tweaks +- #61: Feature: shake the phone to send feedback email +- #62: Improvement: visual polishing for top stories +- #60: Internal: setup hockeyapp for crash reporting +``` + +or + +``` +$ pr_changelog --format pretty 0.3.0 0.5.0 +``` + Will produce: ```markdown ## Changes since 0.3.0 to 0.5.0 @@ -56,29 +92,9 @@ - #62: 💎 Visual polishing for top stories [Internal] - #65: 👨‍💻 Add formatting rules for xml files - #60: 👨‍💻 Setup hockeyapp for crash reporting -``` - -or - -``` -$ pr_changelog --format plain 0.3.0 0.5.0 -``` - -Will produce something like: - -```markdown -## Changes from 0.3.0 to 0.5.0 - -- #64: Improvement: visual refinements for canvas 2.0 -- #65: Internal: add formatting rules for xml files -- #63: Feature: Add Footer story -- #57: Improvement: Memory performance tweaks -- #61: Feature: shake the phone to send feedback email -- #62: Improvement: visual polishing for top stories -- #60: Internal: setup hockeyapp for crash reporting ``` ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/schibsted/pr_changelog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.