tyler.durden
/
keep-a-changelog
mirror of https://github.com/olivierlacan/keep-a-changelog.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
If you build software, keep a changelog.
175 Commits 12 Branches 14 Tags 17 MiB
Haml 97.2%
Sass 1.4%
Ruby 1.3%
Go to file
Olivier Lacan 57a3020b78 Sweating the details with styles 2017-05-24 11:40:09 -04:00
source Sweating the details with styles 2017-05-24 11:40:09 -04:00
.editorconfig Add charset config to .editorconfig 2016-07-29 01:59:22 +09:00
.gitignore @jswanner says I should ignore this 2016-08-05 20:00:22 -04:00
.ruby-version Upgrade to Middleman 4.1.10 2016-08-06 01:37:12 -04:00
CHANGELOG.md Add glorious @tylerfortune8 styling for 1.0.0 2017-05-16 10:43:55 -06:00
CONTRIBUTING.md Rewrite README to focus on development 2016-08-06 02:02:30 -04:00
Gemfile Upgrade to Middleman 4.1.10 2016-08-06 01:37:12 -04:00
Gemfile.lock Bump Redcarpet to solve anchor issues 2017-04-17 16:21:47 +02:00
LICENSE Convert static files to a Middleman app. 2015-10-18 16:35:53 -04:00
README.md Add new project logo 2017-04-24 17:05:25 -04:00
Rakefile Convert static files to a Middleman app. 2015-10-18 16:35:53 -04:00
config.rb Add glorious @tylerfortune8 styling for 1.0.0 2017-05-16 10:43:55 -06:00

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
  • middleman starts the local development server at http://localhost:4567

Deployment

  • 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-US/index.html.haml file in source/fr-CA.
  • edit source/fr-CA/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!