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

Add a complete and verbose changelog #275

Open
dstansby opened this issue Nov 22, 2024 · 0 comments
Open

Add a complete and verbose changelog #275

dstansby opened this issue Nov 22, 2024 · 0 comments

Comments

@dstansby
Copy link
Contributor

As far as I can see, there is no complete changelog between versions of the OME-NGFF spec. The closest I can find is https://ngff.openmicroscopy.org/0.5/index.html#history, which only has a very short sentence on what changed in each version.

As a concrete example, in v0.5 axis types were narrowed so they have to be strings. But I have absolutely no easy way of knowing that this changed happened, making it very hard for me to make sure that I have finished updating an implementation of the v0.5 spec.

I propose that a complete, verbose changelog is added to the specification docs that explain every change that happens to the spec between versions. This would make it easy for users to understand what new features have been added, and easy for implementers to update their implementations with new versions of the spec.

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

1 participant