mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-07-31 01:34:18 +02:00
d3b8a2ad3b
Bumps [redcarpet](https://github.com/vmg/redcarpet) from 3.6.0 to 3.6.1. - [Release notes](https://github.com/vmg/redcarpet/releases) - [Changelog](https://github.com/vmg/redcarpet/blob/master/CHANGELOG.md) - [Commits](https://github.com/vmg/redcarpet/compare/v3.6.0...v3.6.1) --- updated-dependencies: - dependency-name: redcarpet dependency-version: 3.6.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>
Don’t let your friends dump git logs into changelogs™
This repository generates https://keepachangelog.com/.
Development
Dependencies
- Ruby (see version, rbenv recommended)
- Bundler (
gem install bundler)
Installation
git clone https://github.com/olivierlacan/keep-a-changelog.gitcd keep-a-changelogbundle installbin/rake servestarts a local development server at http://localhost:4567 which will reload with any local file changesbin/rake buildruns middleman build with--verboseflag so build errors are logged for easier debugging
Deployment
bin/rake cleancan clean a corruptedbuild/directory in casepublishfailedbin/rake deploycleans, builds and pushes to thegh-pagesbranch on GitHub so the site is deployed to keepachangelog.com
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-CAdirectory. - duplicate the
source/en/1.0.0/index.html.hamlfile insource/fr-CA. - edit
source/fr-CA/1.0.0/index.html.hamluntil 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!