Skip to content

Commit 430b12e

Browse files
committed
Clarify version scheme
1 parent 02d6110 commit 430b12e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

CHANGELOG.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@ Changelog
22
=========
33

44
Versions follow `CalVer <https://calver.org>`_ with a strict backwards compatibility policy.
5-
The third digit is only for regressions.
5+
6+
The **first digit** of the version is the year.
7+
The **second digit** is incremented with each release, starting at 1 for each year.
8+
The **third digit** is when we need to start branches for older releases (only for emergencies).
69

710
Put simply, you shouldn't ever be afraid to upgrade ``attrs`` if you're only using its public APIs.
811
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.

0 commit comments

Comments
 (0)