Don’t let your friends dump git logs into changelogs™
This repository generates https://keepachangelog.com/.
- Ruby (see version, rbenv recommended)
- Bundler (
gem install bundler
)
git clone https://github.com/olivierlacan/keep-a-changelog.git
cd keep-a-changelog
bundle install
bin/rake serve
starts a local development server at http://localhost:4567 which will reload with any local file changesbin/rake build
runs middleman build with--verbose
flag so build errors are logged for easier debugging
bin/rake clean
can clean a corruptedbuild/
directory in casepublish
failedbin/rake deploy
cleans, builds and pushes to thegh-pages
branch on GitHub so the site is deployed to keepachangelog.com
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 insource/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!