From 430b12ef0c539f28392b7d818af8dd8351e6c72b Mon Sep 17 00:00:00 2001 From: Hynek Schlawack Date: Thu, 16 Dec 2021 08:18:17 +0100 Subject: [PATCH] Clarify version scheme --- CHANGELOG.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3773a973d..e5c603ce7 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,7 +2,10 @@ Changelog ========= Versions follow `CalVer `_ with a strict backwards compatibility policy. -The third digit is only for regressions. + +The **first digit** of the version is the year. +The **second digit** is incremented with each release, starting at 1 for each year. +The **third digit** is when we need to start branches for older releases (only for emergencies). Put simply, you shouldn't ever be afraid to upgrade ``attrs`` if you're only using its public APIs. Whenever there is a need to break compatibility, it is announced here in the changelog, and raises a ``DeprecationWarning`` for a year (if possible) before it's finally really broken.