CONTRIBUTING.md 654 Bytes
Newer Older
Thomas Frion's avatar
Thomas Frion committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# Contributing rules

## Commit name

The commit name should be a summary of what you did. It should be accompanied by a description detailing what you did, any problems you encountered, and what remains to be done.

Each commit must have a name that starts with the following elements:

* `[FEAT]` For a new feature
* `[FILE]` For a new file
* `[CPNT]` For a new component
* `[UPDF]` For a feature update
* `[UPDC]` For a feature component
* `[FIX]`  For a bug fix


## Branch name

A branch must be created by functionality, component, issue.

Thomas Frion's avatar
Thomas Frion committed
21
If the branch to be created is linked to an issue, then the name of the branch must start with the issue id.