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 version scheme to Contributing Guide #407

Merged
merged 2 commits into from
Jun 22, 2022
Merged

Conversation

csarven
Copy link
Member

@csarven csarven commented May 12, 2022

No description provided.

@csarven csarven requested a review from a team May 12, 2022 16:39
Copy link
Member

@kjetilk kjetilk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer if panels could use version <1 for their initial releases of documents that have not yet been submitted to the Solid Editors.

Also, I note that the Solid Protocol itself is not ready to follow this requirement.

But in the interest of this not becoming a permathread, I approve.

Copy link
Member

@justinwb justinwb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Considered whether or not it's worth specifying that early / in-progress can use 0.X.X, but I think it's implicit with semver so I'm fine with it as it is.

@csarven
Copy link
Member Author

csarven commented May 12, 2022

I think publications at spaces other than https://solidproject.org/TR/ can use what they see fit, but I do agree that they might want to consider using <1 to make things clear. Currently they use ED. I'm open to adding a guideline along those lines if that's helpful - yay/nay?

Edit: And yes, this version scheme will be effective for new releases.

Copy link
Contributor

@RubenVerborgh RubenVerborgh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy with the proposal; just want to raise that the specific notation Version 1.0.0-WD.20221231 might cause confusion. It might be read as "version 1.0.0 with date xxx" or something. Perhaps DRAFT can be labeled more explicitly, but that's just usability on the document.

@elf-pavlik
Copy link
Member

During the Solid Notification call, @csarven mentioned that the next release of Solid Protocol will add new features including a new Solid Notifications Protocol. As I understand semver, that next release should be 0.10.0 not 0.9.1.

I believe we shouldn't use pre-release until we consider the spec CR/PR equivalent.

@csarven csarven merged commit 1eb79d0 into main Jun 22, 2022
@csarven csarven deleted the contributing/version-scheme branch October 14, 2022 17:06
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

Successfully merging this pull request may close these issues.

6 participants