Update Developer guide - semantic versioning authored by Bouvry Arnaud's avatar Bouvry Arnaud
...@@ -3,12 +3,23 @@ title: Developer guide ...@@ -3,12 +3,23 @@ title: Developer guide
--- ---
# Joining the developers of PASE # Joining the developers of PASE
All contributions are welcome. To start coding : All contributions are welcome. To start coding :
- read this developer guide completely for essential information and practices to follow - read this developer guide completely for essential information and practices to follow
- either check the issues or get in touch with the team (see [Contact](contact) page) to join the collaboration - either check the issues or get in touch with the team (see [Contact](contact) page) to join the collaboration
- clone the repository - clone the repository
- use an existing branch or create one according to the [branching workflow](#Branching-workflow) - use an existing branch or create one according to the [branching workflow](#branching-workflow)
# Semantic versioning
The PASE repository follows the recommendations of [semantic versioning](https://docs.npmjs.com/about-semantic-versioning ).
A release of the software is identified with its version number vX.Y.Z following the table below.
| Position | Description | Changes | Action | Example: this version | becomes |
|----------|---------------|--------------------------------------------------|-------------------------------------------------|-----------------------|---------|
| X | Major release | Changes that break backward compatibility | Increment the 1st digit, set the following to 0 | v1.2.5 | v2.0.0 |
| Y | Minor release | Changes that do not break backward compatibility | Increment the 2nd digit, set the following to 0 | v1.2.5 | v1.3.0 |
| Z | Patch release | Backward compatible bug fixes | Increment the 3rd digit | v1.2.5 | v1.2.6 |
# Branching strategy : git-flow # Branching strategy : git-flow
source : https://nvie.com/posts/a-successful-git-branching-model/ source : https://nvie.com/posts/a-successful-git-branching-model/
... ...
......