Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.11 KB

VERSIONING.md

File metadata and controls

36 lines (24 loc) · 1.11 KB
Raw

VERSIONING

This file explains the versioning, branching and API model of this project.

Versioning

The versioning is inspired by Semantic Versioning:

Given a version number MAJOR.MINOR.PATCH, increment the:

  1. MAJOR version when you make incompatible API changes
  2. MINOR version when you add functionality in a backwards-compatible manner
  3. PATCH version when you make backwards-compatible bug fixes

Branching Model

The branching is inspired by @jbenet simple git branching model:

  1. master must always be deployable.
  2. all changes are made through feature branches (pull-request + merge)
  3. rebase to avoid/resolve conflicts; merge in to master

Branch naming

Descriptive names are used for branches, for instance: user/appkernel-1.

This example uses a prefix for the type of work done, and a suffix to point to the related issue.

Examples of prefixes would be:

  • user/* for User Stories
  • tech/* for Tech Stories
  • doc/* for documentation
  • fix/* for bug fixes