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

This repository generateshttps://keepachangelog /.

Development

Dependencies

• Ruby (see version,rbenvrecommended)
• Bundler (gem install bundler)

Installation

• git clone https://github /olivierlacan/keep-a-changelog.git
• cd keep-a-changelog
• bundle install
• bin/rake servestarts a local development server athttp://localhost:4567 which will reload with any local file changes
• bin/rake buildruns middleman build with--verboseflag so build errors are logged for easier debugging

Deployment

• bin/rake cleancan clean a corruptedbuild/directory in casepublishfailed
• bin/rake deploycleans, builds and pushes to thegh-pagesbranch on GitHub so the site is deployed to keepachangelog

Translations

Create a new directory insource/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 thesource/fr-CAdirectory.
• duplicate thesource/en/1.0.0/index.html.hamlfile insource/fr-CA.
• editsource/fr-CA/1.0.0/index.html.hamluntil your translation is ready.
• commit your changes to your ownfork
• submit aPull Requestwith 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!