Skip to content

Commit

Permalink
changelog: mention the underscore anti-example
Browse files Browse the repository at this point in the history
  • Loading branch information
Balazs Kezes committed Aug 4, 2024
1 parent 27c81a4 commit 68a2789
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,9 @@ Recommended tags in priority order:
- new: this is a new feature, should not cause any problems during upgrades.
- info: this is not a change, just an informational message.

It's important to put the breaking changes to the top and highlight them.
For example in the above referenced underscore example, the `template` related breaking change was mentioned only at the end so it was very easy to miss: [https://underscorejs.org/#1.7.0](https://underscorejs.org/#1.7.0).

## Notes

### How strict are the rules? What if urgent incompatible changes are required by sensitive security issue?
Expand Down

0 comments on commit 68a2789

Please sign in to comment.