If you build software, keep a changelog.
Olivier Lacan ba2d594f31 Fix illegal nesting 1 year ago
source Fix illegal nesting 1 year ago
.editorconfig Add charset config to .editorconfig 3 years ago
.gitignore Swedish translation of v1.0.0 2 years ago
.ruby-version Upgrade to Middleman 4.1.10 3 years ago
CHANGELOG.md Merge branch 'master' into cs-v1.0.0 1 year ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2 years ago
CONTRIBUTING.md Rewrite README to focus on development 3 years ago
Gemfile Upgrade to Middleman 4.1.10 3 years ago
Gemfile.lock Upgrade Haml & middleman 2 years ago
LICENSE Convert static files to a Middleman app. 3 years ago
README.md Don’t run rake without bundle exec 2 years ago
Rakefile Convert static files to a Middleman app. 3 years ago
config.rb add slovak translation 1 year ago

README.md

Keep a Changelog

version license

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

This repository generates http://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

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.

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