chore: Update CHANGELOG for v0.3.0#131
Conversation
Document breaking changes for version 0.3.0.
| @@ -4,6 +4,8 @@ All significant changes to this project will be documented in this file. | |||
|
|
|||
| ## Unreleased | |||
There was a problem hiding this comment.
We can drop this "Unreleased"?
There was a problem hiding this comment.
Nope. It's a stub for the next unreleased changelog. An empty "Unrelesed" section would not cause misunderstanding and it simplifies contributors to attatch changelog entries instead of the very first contributor should add an "Unreleased" heading.
There was a problem hiding this comment.
Maybe it would be nice to add an HTML style comment to denote that. Thanks for the explanation.
There was a problem hiding this comment.
Would you submit a PR to add one?
It's intuitive to me when I learn this pattern from somewhere like https://github.com/open-telemetry/opentelemetry-rust/blob/b1393e31c12543e704be6d4595b3d22134c59f9b/opentelemetry-http/CHANGELOG.md.
There was a problem hiding this comment.
I adopt this pattern for most of my projects, BTW (e.g., https://github.com/scopedb/scopeql/blob/2e34a2cd47f6996874e45b1ddac030f643b2abe4/CHANGELOG.md)
There was a problem hiding this comment.
Would you submit a PR to add one?
Sure. Why not! Looks actually like a fairly nice approach and might enforce PR creators to also include an entry in the CHANGELOG.md so it can always be up-to-date with unreleased changes.
2 participants
Document breaking changes for version 0.3.0.