Skip to content

Commit and branches naming guidelines

felixbouveret edited this page Feb 12, 2022 · 2 revisions

These rules are here to have a consistent git history around all the repository. Please follow them as much a you can if you wish to contribute to the project.

Branches

The branches name format is an important format to follow since it either links directly your branch to the issue your are working on or tels precisely what you are working on.

When you are not working on a specific issue just replace the #issueID with #noid.

Example

Type : feat, fix, lint, wip

{type}/#{issueID}-{feature-name}

Commits

We are trying to follow the Angular Commit Message Format. This allows the project to have an easier to read and more consistent commit history.

Try to always use imperative in your commits messages: fix not fixed nor fixes

Example

Types : feat, fix, lint, wip, doc

{type}({scope}) : {description}

Clone this wiki locally