starsArchive/_X_delete_olivierlacan-keep-a-changelog
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
614 commits 15 branches 14 tags 17 MiB
  • Haml 97.2%
  • Sass 1.4%
  • Ruby 1.3%
Find a file
Exact
wackbyte e2894e1896
Some checks failed
Ruby / test (3.3) (push) Has been cancelled
Details
Use link rather than empty anchor for Mastodon link verification (#595)
2025-03-31 08:22:03 -07:00
.github Stay on latest version of setup-ruby 2024-05-23 17:50:12 -07:00
bin Clarify development commands 2023-03-07 18:40:37 -08:00
data Fix GitHub issues link 2024-02-04 18:10:02 -08:00
source Use link rather than empty anchor for Mastodon link verification (#595) 2025-03-31 08:22:03 -07:00
test Add basic build test 2024-05-23 17:46:24 -07:00
.editorconfig Add charset config to .editorconfig 2016-07-29 01:59:22 +09:00
.gitignore Fix versioning for Polish and Slovenian. Add 1.1.0 for Ukrainian. (#592) 2024-02-04 15:32:26 -08:00
.ruby-version Bundleup (#620) 2024-05-23 17:30:44 -07:00
CHANGELOG.md Add swedish 1.1 to changelog 2024-02-05 09:09:51 -08:00
CODE_OF_CONDUCT.md Format all the markdown files with markdownlint (#318) 2019-10-21 11:14:48 -04:00
config.rb Remove outdated comment 2024-02-04 21:21:36 -08:00
CONTRIBUTING.md Rewrite README to focus on development 2016-08-06 02:02:30 -04:00
Gemfile Bump standard from 1.39.2 to 1.40.0 (#633) 2024-09-27 11:15:17 -07:00
Gemfile.lock Bump rack from 2.2.9 to 2.2.13 (#653) 2025-03-31 07:48:44 -07:00
LICENSE Convert static files to a Middleman app. 2015-10-18 16:35:53 -04:00
Rakefile Add basic build test 2024-05-23 17:46:24 -07:00
README.md Update docs 2024-02-04 21:26:24 -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
  • bin/rake serve starts a local development server at http://localhost:4567 which will reload with any local file changes
  • bin/rake build runs middleman build with --verbose flag so build errors are logged for easier debugging

Deployment

  • bin/rake clean can clean a corrupted build/ directory in case publish failed
  • bin/rake deploy cleans, builds and pushes to the gh-pages branch 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-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!