If you build software, keep a changelog. Modified version for my use case https://keepachangelog.franco.net.eu.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Franco Masotti 956d35ad9e
Removed GitHub support. Updated dependencies.
5 months ago
source Removed Google fonts. Added note in readme. 5 months ago
.editorconfig Add charset config to .editorconfig 6 years ago
.gitignore Added the dutch translation of the "Inconsistent changes" section (#372) 1 year ago
.ruby-version Bump to Ruby 2.7 2 years ago
CHANGELOG.md GitHub username change (#390) 1 year ago
CODE_OF_CONDUCT.md Format all the markdown files with markdownlint (#318) 3 years ago
CONTRIBUTING.md Rewrite README to focus on development 6 years ago
Gemfile Removed GitHub support. Updated dependencies. 5 months ago
Gemfile.lock Removed GitHub support. Updated dependencies. 5 months ago
LICENSE Convert static files to a Middleman app. 7 years ago
Makefile Removed GitHub support. Updated dependencies. 5 months ago
README.md Removed GitHub support. Updated dependencies. 5 months ago
config.rb Removed tracker. Fixed last version id. Adapted domain name. 5 months ago

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.franco.net.eu.org/ and is a modified version of the original (https://github.com/olivierlacan/keep-a-changelog) without trackers and remote fonts.

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

Command Description
bundle exec middleman build --verbose builds files in the build directory

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!