[Issue]: Versioning conformance tests

Open
#147 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
python

Research direction

Start by locating the conformance package and testing framework, then inspect how package and spec versions are currently represented and released. Review the linked versioning guidance and the discussion before proposing a scheme that supports synchronized and independent changes; done means the versioning policy and its handling of supported spec versions are agreed.

Written by the indexing model from the issue text.

Description

Describe the issue

@clbarnes and other folks, I wanted to open this issue to discuss versioning for the conformance tests and testing framework.

However we choose to package/distribute the tests for downstream consumption, we'll want to make sure that:

  • the conformance package version and spec version can be kept in sync
  • the conformance package version and spec version can be changed independently

In GEFF we use a hybrid versioning scheme consisting of 5 numbers. For the conformance testing package, this could look like vX.Y.Z.A.B where vA.B would be the highest supported version of the spec. The numbers X.Y.Z could be bumped according to semver, effver, or any other suitable versioning scheme.

Let's say we cut a new version of this conformance package (say "v0.1.0") for spec release v0.6. Under the hybrid versioning scheme, this could be v0.1.0.0.6. If we realized there was a bug in the package, we could release v0.1.1.0.6. If version 0.7 of the spec is released, we'd probably be adding new features to the tests, so we could release v0.2.0.0.7... etc.

We'll have to think about what that looks like with v0.4 and v0.5 re. "the highest supported version".

Dominant language
Python
Stars
14
Forks
19
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ome/ngff-spec

All issues in ome/ngff-spec

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.