This file is currently not complete but will be improve step by step.
This project use semantic versionning to define the releases. This mean that each stable release of the project will get associate a version number of the form vX.Y.Z.
- X define the major version number
- Y define the minor version number
- Z define the patch version number
When a release contains only bug fixes, the patch number increase. When the release contains new features backward compatibles, the minor version increase. When the release contains breaking changes, the major version increase.
Thus, it should be safe to depend on a fixed major version and moving minor version of this project.
This project use gitflow management.
This project contains two main branches:
- master : This branch is a stable branch. Each version on this branch should be a stable release of the project, and idealy each commit modifying the source code of the project should be tagged with a version number.
- development : This branch contains the current development of this project.
When a new feature will take some time to implement, this feature should be developed in a specific branch. Once done, it will be merged in development before the next release of the project.
If a bug is found in a stable version and the correction is backward compatible, it should be corrected in an hotfix branch. Once the correction is finished the hotfix branch should be merged into master and development and a new bugfix release should be done.