Branch system

Branch System

There are 2 main branch.

The first one is master, the second is dev.

master is the production branch and dev is the pre-production branch.

Each of these branch are protected by rules.

Rules

branch	number of PR review
master	2
dev	1
xxx	0

Roles

branch	role
master	only production code
dev	code that is ready for testing
feature/yyy	developement for yyy feature
hotfix/xxx	fix of bug for the xxx feature
bootstrap	developement of prototype

Example

Case : Developement of a feature called "toto"

1. push code to feature/toto

2. once the code seems to be ready: the testing will take place on feature/toto

3. when the test phase is done: open a new pull request in order to merge feature/toto into dev

4. dev now contains the feature "toto", we can now also run some test on the epitech repository's dev branch.

5. when all the testing is done, the feature "toto" will be "production ready" and on hold on dev.

6. when we are ready to put in production our code, we merge dev into master.

7. master will contain the new code and push to the production server.

8. later on if something is wrong about the feature "toto" on the branch master, we can create a branch hotfix/toto, push the fix on it and continue from the step 3.