solid / solid/data-interoperability-panel

Define meaning / purpose of version numbering in shape tree specification

Open
#220 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Bikeshed
Stars
58
Forks
18
PR merge metrics
No merged PRs in 30d

Description

Version numbering in the shape tree specification may enable easy distinguishing of new vs. old instances. However the meaning of the version number should be made explicit.

Pros of version numbering:

  • Enables easy comparison of definitions
  • Enables easy checking of temporal ordering of definitions

Cons of version numbering:

  • Downstream uses of shape trees and shapes are unknown and thus it is difficult to know what constitutes a breaking change that would be a minor vs. major version number.
  • Version numbering requires synchronization between the data structure and the version number; it's possible that the version number will be accidentally left the same during an update, creating a risk of reliance upon it.

Proposed resolution: a monotonically-increasing version number (with no distinction between major/minor) is simple and effective without overclaiming its meaning.

cc: @elf-pavlik @justinwb

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

No file, test, or entry point is named in the issue, so first locate the shape tree specification and review how version numbers are currently defined. Done means the specification explicitly states whether version numbers are monotonically increasing and what their purpose and limitations are.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.