From 9358d3d2646fce9448c7e8f192f67d43cd317cdd Mon Sep 17 00:00:00 2001 From: ClementTsang <34804052+ClementTsang@users.noreply.github.com> Date: Tue, 13 Aug 2024 22:44:11 -0400 Subject: [PATCH] add some details about versioning --- CHANGELOG.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5b468a2eb..9cc74a936 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,24 @@ # Changelog -All notable changes to this project will be documented in this file. +All notable changes to this project will be documented in this file. The format is based on +[Keep a Changelog](https://keepachangelog.com/en/1.0.0/). -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +Versioning for this project is based on [Semantic Versioning](https://semver.org/spec/v2.0.0.html). More specifically: + +**Pre 1.0.0 (current)**: + +- Patch versions should aim to only contain bug fixes or non-breaking features/changes. +- Minor versions may break things. + +**Post 1.0.0**: + +- Patch versions should only contain bug fixes. +- Minor versions should only contain forward-compatible features/changes. +- Major versions may break things. + +That said, these are more guidelines rather than hardset rules, though the project will generally try to follow them. + +--- ## [0.11.0]/[0.10.3] - Unreleased