Thank you to take time for our project !
If not installed, please follow the local development guidelines to install the project on your local environment.
Reminder: Ubuntu dev env is prefered
- All new code is pushed on a new branch (see below) and when it needs to be merged to develop, goes thew a Pull Request. Commits on develop will be rejected and reverted!!
- Code need to be tested : see the testing guidelines
- Run the
yarn run lint
tool to check errors. - Run the
yarn run format
tool to beautify your code. It will be run as a pre-commit hook.
Use gitflow for branch managment.
Installation
sudo apt install git-flow
Branch type | gitflow prefix |
---|---|
Feature | feat/ |
Bugfix | fix/ |
Release | release/ |
Other are default, using master and develop.
Once you have finished your work, push to github and open a PR (Pull Request).