Skip to content
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.

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

Maintain a CHANGELOG.md #248

Closed
mxinden opened this issue Nov 14, 2022 · 3 comments
Closed

Maintain a CHANGELOG.md #248

mxinden opened this issue Nov 14, 2022 · 3 comments

Comments

@mxinden
Copy link
Member

mxinden commented Nov 14, 2022

As a downstream user, it would be very helpful to have a changelog for each release. A changelog would allow downstream users to quickly understand the impact of an update like multiformats/rust-multiaddr#63.

I don't have a strong opinion on a format, though favor https://keepachangelog.com/ for the sake of consistency with other projects.

Would this be an option for this project as well?

Thanks for all the work here.
Max - Happy downstream user

@vmx
Copy link
Member

vmx commented Nov 14, 2022

Yes, it surely would make sense. Given that we (mostly) follow https://www.conventionalcommits.org/en/v1.0.0/, we could even auto-generate one and clean it up before committing. I can only speak for myself, but this didn't happen in the past as I hardly even found the time to do minimal maintenance on this library.

@vmx
Copy link
Member

vmx commented Dec 6, 2022

We now have a changelog!

@vmx vmx closed this as completed Dec 6, 2022
@mxinden
Copy link
Member Author

mxinden commented Dec 8, 2022

🙏 Thanks @vmx!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants