Merge pull request #50 from openzim/breaking_changes

Add precision about breaking changes
openzim · Nov 7, 2024 · 4141bf2 · 4141bf2
2 parents ad7670f + 083f845
commit 4141bf2
Showing 1 changed file with 3 additions and 1 deletion.
diff --git 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.
+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.