From a90bcf78272a909f0f0dbb960c048968e05dd657 Mon Sep 17 00:00:00 2001 From: Matt Culler Date: Thu, 18 Jul 2024 10:29:03 -0400 Subject: [PATCH] docs: update hacking with explanation for exclamation point (#226) * docs: update hacking with explanation for exclamation point * Update HACKING.rst Co-authored-by: Alex Lowe --------- Co-authored-by: Alex Lowe --- HACKING.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/HACKING.rst b/HACKING.rst index 1c3865c..bc49c40 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -167,11 +167,11 @@ Commits Commit messages are based on the `conventional commit`_ style:: - (): + [(optional scope)][!]: - + [optional body] - + [optional footer] The commit is divided into three sections: a header, body, and footer. @@ -297,6 +297,16 @@ class name. If a commit affects many areas of the codebase, the scope should be omitted; ``many`` is not an accepted scope. +Breaking changes +################ + +If an exclamation point (``!``) is inserted after the type/scope, this means +that the commit introduces a breaking change. Including one or more commits +with an exclamation point in a release will trigger a major version increment. + +Breaking changes may also be indicated by including the words ``BREAKING CHANGE`` +in the commit footer. + Description ###########