If you build software, keep a changelog.
Clone or download
Latest commit f4c0c08 Nov 7, 2018

README.md

Keep a Changelog

version license

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

This repository generates https://keepachangelog.com/.

Development

Dependencies

Installation

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

Docker

  • git clone https://github.com/olivierlacan/keep-a-changelog.git
  • cd keep-a-changelog
  • docker build -t keep-a-changelog
  • docker run -p 4567:4567 keep-a-changelog starts the docker development server and binds it at http://localhost:4567

Deployment

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

Translations

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.

Contribute

Please do contribute! Issues and pull requests are welcome.

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