Source control

[TheRefraction]

Source control

Branches

Each branch has a given purpose as shown below:

• master: This is the branch for the main production. This branch is protected.
• dev: This is the branch for the development of a given version. This branch is also protected and shall be pulled to master at the end of a development cycle. Any new feature will be implemented in another branch (which is created from dev), then the latter is pushed and reviewed to dev.
• docs: This is the branch for documentation in Markdown and for the report (LaTeX). This branch is of master and is then pushed to the latter.

Pull requests

By default, any contributor cannot push to the following branches: master and ````dev```. Thus, a new branch should be created, then pulled and reviewed by others. If changes consist of a single commit (like a hotfix), then it can directly be pulled and reviewed without creating a new branch.

The one that opened the pull-request must be the one that closes it. At least one must review and choose whether to accept or decline.

Branch Merge Protection

The following merges are allowed, others are automatically declined:

• master < dev, master < docs
• docs < any (except any main branch)
• dev < any (except any main branch)

How to name a new branch

It depends on what you are actually going to be working on. Let name be the main focus of your branch. Thus we can have the following convention:

• feature-name for a new feature
• migration-name for a new set of migrations
• config-name if config files are being modified
• hotfix-name for a urgent bug fix
• fix-name for bug fixes
• refactor-name for code restructuring without changing behavior
• wip-name for a work-in-progress feature (should be temporary)