Keep a Changelog in reStructuredText!

README.rst

Keep a Changelog in reStructuredText

Same as the markdown version.

pandoc --from markdown --to rst

Reference

• olivierlacan/keep-a-changelog#340

License

SPDX-License-Identifier: MIT

CHANGELOG.rst

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Please see all Unreleased Changes for more information.

1.1.0 - 2019-02-15

Added

• Danish translation from [@frederikspang](https://github.com/frederikspang).
• Georgian translation from [@tatocaster ](https://github.com/tatocaster).
• Changelog inconsistency section in Bad Practices

Changed

• Fixed typos in Italian translation from [@lorenzo-arena](https://github.com/lorenzo-arena).
• Fixed typos in Indonesian translation from [@ekojs](https://github.com/ekojs).

1.0.0 - 2017-06-20

Added

• New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
• Version navigation.
• Links to latest released version in previous versions.
• “Why keep a changelog?” section.
• “Who needs a changelog?” section.
• “How do I make a changelog?” section.
• “Frequently Asked Questions” section.
• New “Guiding Principles” sub-section to “How do I make a changelog?”.
• Simplified and Traditional Chinese translations from [@tianshuo](https://github.com/tianshuo).
• German translation from [@mpbzh](https://github.com/mpbzh) & [@Art4](https://github.com/Art4).
• Italian translation from [@azkidenz](https://github.com/azkidenz).
• Swedish translation from [@magol](https://github.com/magol).
• Turkish translation from [@karalamalar](https://github.com/karalamalar).
• French translation from [@zapashcanon](https://github.com/zapashcanon).
• Brazilian Portugese translation from [@Webysther](https://github.com/Webysther).
• Polish translation from [@amielucha](https://github.com/amielucha) & [@m-aciek](https://github.com/m-aciek).
• Russian translation from [@aishek](https://github.com/aishek).
• Czech translation from [@h4vry](https://github.com/h4vry).
• Slovak translation from [@jkostolansky](https://github.com/jkostolansky).
• Korean translation from [@pierceh89](https://github.com/pierceh89).
• Croatian translation from [@porx](https://github.com/porx).
• Persian translation from [@Hameds](https://github.com/Hameds).
• Ukrainian translation from [@osadchyi-s](https://github.com/osadchyi-s).

Changed

• Start using “changelog” over “change log” since it’s the common usage.
• Start versioning based on the current English version at 0.3.0 to help translation authors keep things up-to-date.
• Rewrite “What makes unicorns cry?” section.
• Rewrite “Ignoring Deprecations” sub-section to clarify the ideal scenario.
• Improve “Commit log diffs” sub-section to further argument against them.
• Merge “Why can’t people just use a git log diff?” with “Commit log diffs”
• Fix typos in Simplified Chinese and Traditional Chinese translations.
• Fix typos in Brazilian Portuguese translation.
• Fix typos in Turkish translation.
• Fix typos in Czech translation.
• Fix typos in Swedish translation.
• Improve phrasing in French t