CONTRIBUTING.md 1.29 KB
Newer Older
Thomas Frion's avatar
Thomas Frion committed
1
2
3
4
5
6
7
8
9
# 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
Thomas Frion's avatar
Thomas Frion committed
10
* `[FILE]` For a new file or for an update of a file (not source code)
Thomas Frion's avatar
Thomas Frion committed
11
12
13
14
* `[CPNT]` For a new component
* `[UPDF]` For a feature update
* `[UPDC]` For a feature component
* `[FIX]`  For a bug fix
Thomas Frion's avatar
Thomas Frion committed
15
16
* `[CLEAN]` For refactoring or deleting unnecessary comments
* `[COMMENT]` For adding comment
Alexandra Chaton's avatar
Alexandra Chaton committed
17
* `[DOC]` For new documentation file or update of the documentation
Thomas Frion's avatar
Thomas Frion committed
18
19
20
21
22
23


## Branch name

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

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

## CHANGLOG

Thomas Frion's avatar
Thomas Frion committed
28
29
30
31
32
33
34
35
36
When you have finished working, you must fill in the changelog with the current date. The changelog should list the main changes and anything else you think is relevant.

## Issues

When you create a new issue, please add the right labels.

* `Back-end`      If this is about the back-end
* `Front-end`     If this is about the front-end
* `Documentation` If this is about the documentation
Thomas Frion's avatar
Thomas Frion committed
37
* `Bugs`           If this is a bug or any trouble