From 5de15f0d6e9247491a7e0b268a3b4a82df5fb975 Mon Sep 17 00:00:00 2001 From: Brecht Machiels Date: Thu, 15 Sep 2022 17:59:04 +0200 Subject: [PATCH] Changelog: add note about backward-incompatible changes --- CHANGES.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 7a85c5e14..40b78ea92 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,13 +1,26 @@ Release History --------------- +.. note:: rinohtype uses `Semantic Versioning`__ for its releases. In summary, + this means that each release gets a version number MAJOR.MINOR.PATCH. The + MAJOR version number is increased when backwards-incompatible API changes + are made. However, until we exit beta and reach version 1.0.0, anything may + change at any time. + + With this in mind, to ease upgrading from a previous version, I try to + explicitly list backward-incompatible changes in the *Changed* section for + each release. Be sure to check these when upgrading. + + .. __: https://semver.org/ + + Release 0.5.5 (in development) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ New Features: * Enumerated list item labels now also respect the *number_separator* style - property, enabling hierarchical list item labels. + property, enabling hierarchical list item labels (discussion #350). * Admonitions now have a 'custom_title_text' property that can be used to style generic admonitions. For example, this style definition applies to ``.. admonition:: Fun Fact``::