WebAssembly / WebAssembly/component-model
Incorrect references to SemVer
Nobody has claimed this yet.
- Dominant language
- WebAssembly
- Stars
- 1.4k
- Forks
- 130
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 15
Description
We've been a little loose in some references to SemVer, especially as it relates to compatibility rules. The SemVer spec itself only defines compatibility for major version > 0 (i.e. >=1.0.0), but the WIT documentation for @since (e.g. here) implies a compatibility requirement between e.g. 0.1.0 and 0.1.1. This does match the popular "caret requirements" versioning strategy used by default in cargo, npm, and elsewhere. We should just be more explicit that this isn't "plain" SemVer.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with design/mvp/WIT.md around line 1300 and compare its @since wording with the SemVer specification and the linked Cargo caret-requirements documentation. Review the other SemVer references mentioned in the issue, clarify where the project uses caret-style compatibility for pre-1.0 versions, and verify that the documentation no longer presents this as plain SemVer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- wasm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100