Skip to content
Go to file
Latest commit c25aae9 Mar 10, 2020 History
I don't use or support Docker for Keep a Changelog development.

I recommend using rbenv or chruby to develop with Ruby. Docker is way too much
overhead (and power usage) on macOS to run something as simple as a middleman site.
# Title

# Tell me everything!

# Co-authors (they will be credited on GitHub as well)
# Co-authored-by: Carolina Powers <>
# Co-authored-by: Meg Kline-Tuls <>
# Co-authored-by: Will <>
# Co-authored-by: thatchej <>
8 contributors

Users who have contributed to this file

@olivierlacan @AlphaDel @romdim @RichardLitt @MOZGIII @katrinleinweber @nbibler @altonius
59 lines (41 sloc) 2.26 KB

Keep a Changelog

Keep a Changelog v1.1.0 badge Version 1.1.0 Badge MIT License Badge

Don’t let your friends dump git logs into changelogs™

This repository generates




  • git clone
  • cd keep-a-changelog
  • bundle install
  • bundle exec middleman starts the local development server at http://localhost:4567


  • bundle exec rake publish builds and pushes to the gh-pages branch


Create a new directory in source/ named after the ISO 639-1 code for the language you wish to translate Keep a Changelog to. For example, assuming you want to translate to French Canadian:

  • create the source/fr-CA directory.
  • duplicate the source/en/1.0.0/index.html.haml file in source/fr-CA.
  • edit source/fr-CA/1.0.0/index.html.haml until your translation is ready.
  • commit your changes to your own fork
  • submit a Pull Request with your changes

It may take some time to review your submitted Pull Request. Try to involve a few native speakers of the language you're translating to in the Pull Request comments. They'll help review your translation for simple mistakes and give us a better idea of whether your translation is accurate.


Please do contribute! Issues and pull requests are welcome.

Thank you for your help improving software one changelog at a time!

You can’t perform that action at this time.