MeadowlarkDAW / creek

Realtime disk streaming IO for audio
Other
112 stars 12 forks source link

Lots of improvements #37

Closed BillyDM closed 8 months ago

BillyDM commented 1 year ago

I was looking over this code last week and I noticed a lot of things I wanted to improve. Here is the list of changes I made:

Needless to say, this contains a lot of breaking changes.

uklotzde commented 1 year ago

Please change the PR merge strategy of the repo to "Allow squash merging" only to avoid merging all those meaningless, intermediate commits:

image

This will create a linear and streamlined commit history.

uklotzde commented 1 year ago

Too many changes for a proper review. I suggest to simply merge this PR and fix any open issues afterwards.

Tagging this repo with "1.0" was too early anyway.

BillyDM commented 1 year ago

Okay, I'll allow squashing commits.

Also yeah, I probably jumped the gun a bit by tagging it "1.0". Would it be possible to revert that?

BillyDM commented 1 year ago

Hmm, there doesn't seem to be any way to revert to a previous version on crates.io. Oh well, I'll just go ahead and merge it.

BillyDM commented 1 year ago

Actually, I'll hear from @Be-ing first.

uklotzde commented 1 year ago

Hmm, there doesn't seem to be any way to revert to a previous version on crates.io. Oh well, I'll just go ahead and merge it.

There is no way back with version. Just increase the major version number on breaking changes.

uklotzde commented 1 year ago

All API changes should ideally be summarized in a CHANGELOG.md file

BillyDM commented 8 months ago

This PR is outdated now and a lot of these things have been fixed in separate PRs, so I think I'll close this. I might get around to revamping the API at some point, but I'd rather do that in a new PR with a fresh perspective.

I'll keep this branch around as reference, but I'll change the name to something like dev_(outdated).