Skip to content

Commit 4141bf2

Browse files
authored
Merge pull request #50 from openzim/breaking_changes
Add precision about breaking changes
2 parents ad7670f + 083f845 commit 4141bf2

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
Mandatory for a versioned project. Must follow [Keep A Changelog](https://keepachangelog.com/en/1.1.0/)'s format.
22

3-
Ideally, entries in response to Github issues should mention them.
3+
Ideally, entries in response to Github issues should mention them.
4+
5+
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.

0 commit comments

Comments
 (0)