14c91c09ed | ||
---|---|---|
source | ||
.editorconfig | ||
.gitignore | ||
.ruby-version | ||
CHANGELOG.md | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
Gemfile | ||
Gemfile.lock | ||
LICENSE | ||
README.md | ||
Rakefile | ||
config.rb |
README.md
Don’t let your friends dump git logs into changelogs™
This repository generates http://keepachangelog.com/.
Development
Dependencies
- Ruby (see version, rbenv recommended)
- Bundler (
gem install bundler
)
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 thegh-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 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.
Thank you for your help improving software one changelog at a time!