mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-07-30 09:14:12 +02:00
fde9698cb0
It’s time. Reworked sections and extracted out-of-band information into a frequently asked questions section as a sort of catch all to keep everything focused. Gave up Markdown since it seriously limits our styling possibilities while Haml doesn’t hurt the legibility or the barrier to entry much. Only part I don’t love yet are the reference links that are now up top in the source file.
Keep a CHANGELOG 
Don’t let your friends dump git logs into CHANGELOGs™
This repository generates http://keepachangelog.com/.
Development
Dependencies
- Ruby (see version, rbenv recommended)
- Bundler (
gem install bundler)
Installation
git clone https://github.com/olivierlacan/keep-a-changelog.gitcd keep-a-changelogbundle installmiddlemanstarts the local development server at http://localhost:4567
Deployment
rake publishbuilds and pushes to thegh-pagesbranch
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-CAdirectory. - duplicate the
source/en-US/index.html.hamlfile insource/fr-CA. - edit
source/fr-CA/index.html.hamluntil 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.
Thank you for your help improving software one changelog at a time!