From 083f8455248b14b4f8b4ea7e2a082d52f9781738 Mon Sep 17 00:00:00 2001 From: benoit74 Date: Tue, 5 Nov 2024 13:34:21 +0100 Subject: [PATCH] Add precision about breaking changes --- docs/CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index ca0a93c..35d196f 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,3 +1,5 @@ Mandatory for a versioned project. Must follow [Keep A Changelog](https://keepachangelog.com/en/1.1.0/)'s format. -Ideally, entries in response to Github issues should mention them. \ No newline at end of file +Ideally, entries in response to Github issues should mention them. + +All breaking changes must be listed under a single `### Breaking Changes` section per release (instead of prefixing them in `### Changed` or `### Fixed`. And this section must be the first section of the (major obviously) release.