search

sunfishcode / origin

Program startup and thread support written in Rust
Other
167 stars 12 forks source link

Add a changelog/releases file #31

Closed morr0ne closed 1 year ago

morr0ne commented 1 year ago

I think it would greatly benefit the project to add a file that keep tracks of changes and/or releases. I think the benefits are obvious but the most notable reason right now is making it clearer what changes between breaking release. I don't think it would make sense to include very old released but 0.12.0 seems like a good starting point considering it was a breaking release and it's the latest one. Ideally this could also be coordinated with github releases, I am not sure what the best tool to keep those 2 things in sync would be but ideally there could be some kind of ci job that handles releases. Perhaps it would make sense to integrate this with something like conventional commits to allow for easy changelog generation without requiring manual intervention. That would also require some kind of contributing guidelines to enforce it but I reckon contributing guidelines are always a good idea.

sunfishcode commented 1 year ago

Yes, this is a good idea. I'm not a fan of conventionalcommits' syntax, but I will try to keep track of breaking changes and add notes to the releases.

sunfishcode commented 1 year ago

I just released 0.13.0, and added release notes here.

morr0ne commented 1 year ago

I feel like release notes should always be included in the repo. What happens if the project is not hosted on github anymore? Or forked? Or if someone wants to check changes from a local copy or mirror? Github releases are great but they should definitely co-exist with a CHANGELOG.md file of sorts

sunfishcode commented 1 year ago

Starting with the 0.14 release, I've now added a CHANGELOG.md file.