docs: Add VERSIONING.md documentation#1735
Merged
Merged
Conversation
Co-Authored-By: lunkai@intrinsictech.xyz <lunkai@intrinsictech.xyz>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
luffykai
changed the title
luffykai
reviewed
Jun 13, 2025
- Clarify that OpenVM follows semver naming but with different principles - Emphasize that minor changes are breaking (vkey changes) - Specify that major versions only change upon significant proof system updates - Emphasize that patch backward compatibility means vkey doesn't change Co-Authored-By: lunkai@intrinsictech.xyz <lunkai@intrinsictech.xyz>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Add VERSIONING.md documentation
This PR adds a new
VERSIONING.mdfile to the root directory of the OpenVM repository to document our semantic versioning principles and backward compatibility guarantees.Changes
VERSIONING.mdwith comprehensive documentation of:Ticket
Link to Devin run
https://app.devin.ai/sessions/ba99b2c95a5e4506b1d1ed5f42fe570c
Testing
This is a documentation-only change with no code modifications required.