Code Monkey home page Code Monkey logo

Comments (2)

lcgraham avatar lcgraham commented on July 16, 2024

Based on quickly skimming some sources (http://semver.org/, stackoverflow) I would suggest we use major.minor.(revision/patch) (X.Y.Z). The current version number is 0.0.0 (in doc/conf.py and setup.py). based on the sites I referenced we've been technically operating at version 0.1.0. Thus, since we are now adopting a versioning system I will mark the current state of the master branch as version 0.1.0.

The current version is tracked in 3 places:

  1. doc/conf.py
  2. setup.py
  3. a git tag (http://git-scm.com/book/en/v2/Git-Basics-Tagging)

Currently the plan was to switch to version 0.2.0 after the Audit is completed and then version 1.0 by the time the Rocky Mountain UQ Workshop occurs once all the examples have been checked and updated.

I like the guidelines in server.org . TL;DR for our project this means:

  • If a dev-* branch (or really any branch) is merged into master UPDATE the version number.
  • ONLY tag the version number on the master branch, use ANNOTATED tags.
  • If you're working on a dev branch then I don't think it matters much what version is recorded in doc/conf.py or setup.py. I think for now it makes sense to list the version it will be included in when merged into the master branch or the version it originated from, but that's just my opinion.
  • Update Z for bug fixes
  • Update Y for backwards compatible functionality updates and backwards changes to the API (reset Z to 0)
  • Update X for backwards incompatible changes to the API (reset Z and Y to 0)

from bet.

lcgraham avatar lcgraham commented on July 16, 2024

Also see https://help.github.com/articles/about-releases/

from bet.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.