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.
442 Commits 11 Branches 14 Tags 17 MiB
Haml 97.2%
Sass 1.4%
Ruby 1.3%
Go to file
dependabot-preview[bot] 81f2abcdec Bump middleman from 4.3.4 to 4.3.5 (#310) 
Bumps [middleman](https://github.com/middleman/middleman) from 4.3.4 to 4.3.5.
- [Release notes](https://github.com/middleman/middleman/releases)
- [Changelog](https://github.com/middleman/middleman/blob/master/CHANGELOG.md)
- [Commits](https://github.com/middleman/middleman/compare/v4.3.4...v4.3.5)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
 		2019-09-13 12:29:10 -04:00
source Change some Japansese expressions to better ones. (#307) 2019-07-30 00:58:49 -04:00
.editorconfig Add charset config to .editorconfig 2016-07-29 01:59:22 +09:00
.gitignore Swedish translation of v1.0.0 2017-06-20 22:46:59 +02:00
.ruby-version Bump Ruby to 2.6.1 2019-03-12 12:02:34 -04:00
CHANGELOG.md Move 1.0.0-related translations to 1.0.0 release 2019-02-15 08:28:03 -05:00
CODE_OF_CONDUCT.md Secure links 2018-04-21 17:56:44 +02:00
CONTRIBUTING.md Rewrite README to focus on development 2016-08-06 02:02:30 -04:00
Dockerfile Added Docker for development 2018-10-27 22:37:22 +02:00
Gemfile Bump middleman from 4.3.4 to 4.3.5 (#310) 2019-09-13 12:29:10 -04:00
Gemfile.lock Bump middleman from 4.3.4 to 4.3.5 (#310) 2019-09-13 12:29:10 -04:00
LICENSE Convert static files to a Middleman app. 2015-10-18 16:35:53 -04:00
README.md Update README.md 2019-02-22 16:07:59 +07:00
Rakefile Convert static files to a Middleman app. 2015-10-18 16:35:53 -04:00
config.rb Add Japanese localization (#294) 2019-03-12 11:29:08 -04:00

README.md

Keep a Changelog

version license

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

Docker

  • git clone https://github.com/olivierlacan/keep-a-changelog.git
  • cd keep-a-changelog
  • docker build -t keep-a-changelog .
  • docker run -p 4567:4567 keep-a-changelog starts the docker development server and binds it 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!