As far as I can tell, breaking changes are documented via the GitHub issue label "breaking changes". Fix CHANGELOG.md to reflect this.
Looking at another Hapi repo though, joi, I see that it also uses "release notes" in CHANGELOG.md to refer to breaking changes, but in that repo it actually seems consistent (although "breaking changes" are also used there). What should the procedure actually be, identifying breaking changes through "release notes" or "breaking changes"?
hueniverse
commented
4 years ago
As far as I can tell, breaking changes are documented via the GitHub issue label "breaking changes". Fix CHANGELOG.md to reflect this.
Looking at another Hapi repo though, joi, I see that it also uses "release notes" in CHANGELOG.md to refer to breaking changes, but in that repo it actually seems consistent (although "breaking changes" are also used there). What should the procedure actually be, identifying breaking changes through "release notes" or "breaking changes"?