Skip to content

Commit

Permalink
Added note about version management.
Browse files Browse the repository at this point in the history
  • Loading branch information
juliendelplanque authored Jun 24, 2019
1 parent 24ced74 commit ed5f1c8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/Installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Installation
- [Basic Installation](#basic-installation)
- [Using as dependency](#using-as-dependency)
- [Version management](#version-management)
- [Provided groups](#provided-groups)

## Basic Installation

Expand Down Expand Up @@ -37,6 +41,18 @@ baseline: spec
spec package: 'My-Package' with: [ spec requires: #('JRPC') ] ]
```

## Version management

This project use semantic versioning to define the releases. This means that each stable release of the project will be assigned a version number of the form `vX.Y.Z`.

- **X** defines the major version number
- **Y** defines the minor version number
- **Z** defines the patch version number

When a release contains only bug fixes, the patch number increases. When the release contains new features that are backward compatible, the minor version increases. When the release contains breaking changes, the major version increases.

Thus, it should be safe to depend on a fixed major version and moving minor version of this project.

## Provided groups
- `Server-Deployment` will load all the packages needed to deploy a JSON RPC Server
- `Client-Deployment` will load all the packages needed to deploy a JSON RPC Client
Expand Down

0 comments on commit ed5f1c8

Please sign in to comment.