Skip to content
This repository was archived by the owner on Oct 2, 2020. It is now read-only.

Versioning

Jump to bottom
Junha Park edited this page Jan 27, 2020 · 1 revision

Here is how versions will be tagged to a certain release.

Every version will be in the format vX.Y.Z, where X denotes major releases, Y denotes minor releases, and Z denotes patches. They can be added to any commit of the master branch which you'd like to tag. For example, if you want to tag a certain version of the master branch as version 1.2.0:

  1. git checkout master && git pull
  2. git tag -a v1.2.0
  3. Include a brief description of the release.

Major releases

These should be incremented by 1 whenever large, backwards-incompatible software/API changes are made. The first of such a release will always be tagged in the format vX.0.0. Something that could warrant a new major release could be a software stack migration.

The first major stable public release should be v1.0.0. If the first release is a Flask application with a MySQL backend and vanilla HTML/CSS, and the next release migrates to (for example) a Ruby on Rails application, this would warrant a v2.0.0 tag.

Beta releases can be tagged in the format v0.Y.Z.

Minor releases

These should be incremented by 1 whenever backwards-compatible changes are made, but new features are added. A new release with a bunch of new features since v1.1.3, for instance, would be tagged v1.2.0.

Patches

These should include small bug fixes and changes to already existing features.

Clone this wiki locally