keep-a-changelog

by olivierlacan

olivierlacan / keep-a-changelog

If you build software, keep a changelog.

4.4K Stars 2.9K Forks Last release: 12 months ago (v1.1.0) MIT License 469 Commits 13 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Keep a Changelog

Keep a Changelog v1.1.0 badge Version 1.1.0 Badge MIT License Badge

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

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!

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.