SolidLabResearch / SolidLabResearch/ODRL-Compliance-Report-Model

Versioning policy for the Compliance Report Model

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

Nobody has claimed this yet.

documentation enhancement
Dominant language
No language data
Stars
4
Forks
2
Avg merge
1h 42m
Merged PRs (30d)
1

Description

While reusing the Compliance Report Model, I noticed three versioning points that may be worth making explicit before wider adoption.

1. Version-specific IRI

The ontology declares owl:versionInfo "0.9.0", but no owl:versionIRI is currently provided, and:

https://w3id.org/force/compliance-report/0.9.0

does not resolve.

Proposal: configure resolvable version-specific W3ID IRIs, and add owl:versionIRI once those redirects exist. The stable report: namespace should remain unchanged for vocabulary terms.

2. Compatibility policy

It would be useful to document how compatibility is determined between releases, e.g.:

  • PATCH: editorial/non-semantic changes
  • MINOR: backward-compatible additions
  • MAJOR: breaking semantic changes

Where appropriate, OWL versioning properties such as owl:priorVersion, owl:backwardCompatibleWith, and owl:incompatibleWith could make these relationships explicit.

Existing term IRIs should remain stable and should not be silently repurposed.

3. ODRL dependency

The model currently references the general ODRL namespace and the live formal-semantics draft. It would be useful to state explicitly which ODRL version a release targets (currently ODRL 2.2) and, where relevant, reference a dated/versioned formal-semantics snapshot .rather than a changing editor's draft. That would let consumers tell whether a given release still applies when a future ODRL version relaesers.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by inspecting the model metadata containing owl:versionInfo, the W3ID redirect configuration, and the current ODRL references. Confirm the intended ODRL 2.2 target and versioning policy; done means version-specific IRIs resolve, compatibility rules are documented, stable term IRIs remain unchanged, and the dependency reference is versioned or dated.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.