CONTRIBUTING.md

How to release

We use Semantic Versioning as guideline for the version management.

Steps to release:

• Create a new branch labeled release/vX.Y.Z from the latest main.
• Improve the version number in changelog.md.
• Verify the content of the changelog.md.
• Commit the modifications with the label Release version vX.Y.Z.
• Create a pull request on github for this branch into main.
• Once the pull request validated and merged, tag the main branch with vX.Y.Z
• After the tag is pushed, make the release on the tag in GitHub

Git: Default branch

The default branch is main. Direct commit on it is forbidden. The only way to update the application is through pull request.

Release tag are only done on the main branch.

Git: Branch naming policy

[BRANCH_TYPE]/[BRANCH_NAME]

• BRANCH_TYPE is a prefix to describe the purpose of the branch. Accepted prefixes are:
  • feature, used for feature development
  • bugfix, used for bug fix
  • improvement, used for refacto
  • library, used for updating library
  • prerelease, used for preparing the branch for the release
  • release, used for releasing project
  • hotfix, used for applying a hotfix on main
  • poc, used for proof of concept
• BRANCH_NAME is managed by this regex: [a-z0-9._-] (_ is used as space character).