From 38dae99d5adb52127bc79fb977a4e7e20f5041ed Mon Sep 17 00:00:00 2001 From: Hugo Osvaldo Barrera Date: Thu, 17 Mar 2022 18:46:17 +0100 Subject: [PATCH] Update changelog for v1.0.0 --- CHANGELOG.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 4ae140548..a02d9a8ab 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,8 +4,22 @@ Changelog This file contains a brief summary of new features and dependency changes or releases, in reverse chronological order. -v0.16.0 -------- +v1.0.0 +------ + +So far we've been bumping the minor version each time we introduced breaking +changes. This can result in downstream breakage for tools and setups that +expect semantic versioning. + +From now on we'll be using semantic versioning and bump the major version +whenever we introduce any breaking changes. Increasing the major number does +not imply that it's a huge release with a lots of changes; it implies that +there is at least one backwards-incompatible change, or a change that requires +intervention. + +In this case we've introduced a new field to the abstract Payment class, so +applications will need to create a new migration to apply it (django's +`makemigrations` should handle this perfectly). - ``billing_phone`` field added to :class:`~.BasePayment`. A migration will be needed since, BasePayment is abstract.