Add versioning to specs #176
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
All specs are MAJOR.MINOR. MAJOR is incremented on breaking changes, MINOR on incompatible changes. A 0.x is experimental. filename/MAJOR.MINOR for git tag for each new version of a given spec.
All at 1.0 apart from LFHS and VOA which are 0.1 as WIP
keszybz
approved these changes
Nov 6, 2025
|
|
||
| ## License | ||
|
|
||
| All specifications are licensed under [CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html). |
Member
There was a problem hiding this comment.
All the individual spec files have a SPDX header with CC-BY-4.0, so this just adds a note that is more visible to readers.
Comment on lines
+51
to
+59
| All specifications are versioned. | ||
|
|
||
| The versioning format is MAJOR.MINOR. | ||
| Compatible changes increment the MINOR version. | ||
| Incompatible changes increment the MAJOR version and reset the MINOR version to `0`. | ||
|
|
||
| Work in progress specifications have a MAJOR version of `0`. | ||
|
|
||
| A `filename/MAJOR.MINOR` git tag will be created when a new version of a given spec is released. |
Member
There was a problem hiding this comment.
Yep, this is great. I had something like this in mind, but the wording is particularly concise and clear.
|
|
||
| | Version | Changes | | ||
| |---------|---------| | ||
| | 0.1 | Work in progress | |
Member
There was a problem hiding this comment.
Hmm, I think we could put 1.0 here. Do you anticipate any bigger changes?
Member
Author
There was a problem hiding this comment.
It had an important change only two days ago, so wanted to be a bit careful here and get the general structure right. We can easily do 1.0 in a separate PR if we feel it's ready
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.