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.
511 Commits 12 Branches 14 Tags 17 MiB
Haml 97.2%
Sass 1.4%
Ruby 1.3%
Go to file
Olivier Lacan 3c5480ec51 Bump to Ruby 3.2.1 & redcarpet 3.6 2023-03-05 16:05:23 -08:00
.github Set up Dependabot PRs 2023-02-07 12:46:33 -05:00
source docs(zh-tw): modify the zh-TW wording (#360) 2023-03-05 16:02:23 -08:00
.editorconfig Add charset config to .editorconfig 2016-07-29 01:59:22 +09:00
.gitignore Added the dutch translation of the "Inconsistent changes" section (#372) 2021-02-02 14:31:16 -05:00
.ruby-version Bump to Ruby 3.2.1 & redcarpet 3.6 2023-03-05 16:05:23 -08:00
CHANGELOG.md Add missing periods at the end of changes (#451) 2023-02-09 10:04:47 -05:00
CODE_OF_CONDUCT.md Format all the markdown files with markdownlint (#318) 2019-10-21 11:14:48 -04:00
CONTRIBUTING.md Rewrite README to focus on development 2016-08-06 02:02:30 -04:00
Gemfile Remove pry from dependencies 2023-02-07 12:47:32 -05:00
Gemfile.lock Bump to Ruby 3.2.1 & redcarpet 3.6 2023-03-05 16:05:23 -08:00
LICENSE Convert static files to a Middleman app. 2015-10-18 16:35:53 -04:00
README.md Remove Docker 2020-03-10 11:53:37 -04:00
Rakefile Convert static files to a Middleman app. 2015-10-18 16:35:53 -04:00
config.rb Add the Arabic translation (1.0.0) (#444) 2023-03-05 15:59:11 -08:00

README.md

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!