Need help with keep-a-changelog?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

olivierlacan
4.8K Stars 3.3K Forks MIT License 487 Commits 93 Opened issues

Description

If you build software, keep a changelog.

Services available

!
?

Need anything else?

Contributors list

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.