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

Pre-release versioning #445

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

notlesh
Copy link
Collaborator

@notlesh notlesh commented Dec 4, 2024

Description

This PR prepares SNOS for its first release by bumping each crate's version to 1.0.0-dev. It's also a suggestion on how to implement versioning based on Semver.

Each crate is independently versioned. This is so changes to one crate don't create noise for the users of other crates.

I also suggest adopting -dev tag to indicate a pre-release version. This is inspired by other projects like Frontier. It's explained well there, but to summarize: appending -dev to the version string flags the version as in the process of being bumped in the next release, making it easier to understand when and how a PR should bump the version.

Issue Number: N/A

Type

  • feature
  • bugfix
  • dev (no functional changes, no API changes)
  • fmt (formatting, renaming)
  • build
  • docs
  • testing

Breaking changes?

  • yes
  • no

@notlesh notlesh requested a review from HermanObst as a code owner December 4, 2024 20:46
Copy link
Collaborator

@HermanObst HermanObst left a comment

Choose a reason for hiding this comment

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

@notlesh some thoughts:

  • I would change the version to v0.1.0 (not v1.0.0)
  • The cairo-lang submodule shouldn't be modified

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.

2 participants