Skip to content

chore: Update CHANGELOG for v0.3.0 #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tisonkun merged 1 commit into from
May 18, 2026
Merged

chore: Update CHANGELOG for v0.3.0 #131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ All significant changes to this project will be documented in this file.

## Unreleased
Copy link
Copy Markdown
Member

@notfilippo notfilippo May 18, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can drop this "Unreleased"?

Copy link
Copy Markdown
Member Author

@tisonkun tisonkun May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

@notfilippo notfilippo May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it would be nice to add an HTML style comment to denote that. Thanks for the explanation.

Copy link
Copy Markdown
Member Author

@tisonkun tisonkun May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

@tisonkun tisonkun May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I adopt this pattern for most of my projects, BTW (e.g., https://github.com/scopedb/scopeql/blob/2e34a2cd47f6996874e45b1ddac030f643b2abe4/CHANGELOG.md)

Copy link
Copy Markdown
Member

@notfilippo notfilippo May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


## v0.3.0 (2026-05-18)

### Breaking changes

* `CountMinSketch` now has a type parameter for the count type. Possible values are `u8` to `u64` and `i8` to `i64`.
Expand Down