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 versioning #102

Open
logoff opened this issue Feb 5, 2020 · 2 comments
Open

Add versioning #102

logoff opened this issue Feb 5, 2020 · 2 comments

Comments

@logoff
Copy link

logoff commented Feb 5, 2020

I use Vanetza in my company, and we like it so much. It would help us a lot of having versioned releases of it. We need to use fixed commits or git submodules in order to develop on top of the library and it is not very handy. I would recommend Semantic Versioning 2.0.0.

@riebl
Copy link
Owner

riebl commented Feb 5, 2020

Why is it better to stick with a particular version (which is in the end only a human-readable tag for a particular commit) instead of tracking commits? Are you concerned about API compatibility?

@logoff
Copy link
Author

logoff commented Feb 5, 2020

There are many reasons:

  1. API compatibility
    In the past I developed an app and later the API changed slightly. It produced compilation errors when cloning master from scratch and building the library.

  2. Meaning
    With semver, you give meaning to every release. Example: a patch or a minor version should not change any API. A major version may do it. A complete new feature should be a new major version if it implies API changes, a bug correction should be a patch.

  3. Easy to remember
    A commit is very difficult to remember, a version X.Y.Z is super easy.

There are many other advantages, but in general versioning is a good choice in my point of view.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants