README.md in pr_changelog-0.1.1 vs README.md in pr_changelog-0.2.0
- old
+ new
@@ -1,7 +1,9 @@
# PR Changelog
+[](https://badge.fury.io/rb/pr_changelog)
+
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
@@ -28,10 +30,12 @@
Then a sample pull request title would be:
> Feature: shake the phone to send feedback email
+This project itself is using this PR convention and the changelog generated with it can be found in https://github.com/schibsted/pr_changelog/releases
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -92,9 +96,35 @@
- #62: 💎 Visual polishing for top stories
[Internal]
- #65: 👨💻 Add formatting rules for xml files
- #60: 👨💻 Setup hockeyapp for crash reporting
+```
+
+## Configuration
+
+Change the emojis or add your own in a `.pr_changelog.json` file:
+
+```json
+{
+ "tags": [
+ {
+ "prefix": "feature",
+ "emoji": "⭐️",
+ "title": "New features"
+ },
+ {
+ "prefix": "improvement",
+ "emoji": "💎",
+ "title": "Improvements"
+ },
+ {
+ "prefix": "unclassified",
+ "emoji": "❓",
+ "title": "Unclassified"
+ }
+ ]
+}
```
## 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.