CONTRIBUTING.md 1.61 KB
Newer Older
Thomas Frion's avatar
Thomas Frion committed
1
2
# Contributing rules

Thomas Frion's avatar
Thomas Frion committed
3
4
5
## Git

### Commit name
Thomas Frion's avatar
Thomas Frion committed
6
7
8
9
10
11

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
12
* `[FILE]` For a new file or for an update of a file (not source code)
Thomas Frion's avatar
Thomas Frion committed
13
14
15
16
* `[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
17
* `[CLEAN]` For refactoring or deleting unnecessary comments
Thomas Frion's avatar
Thomas Frion committed
18
* `[WIP]` For Work in progress. Use it to make a save of your work, or if no flag above match with your commit
Thomas Frion's avatar
Thomas Frion committed
19
* `[COMMENT]` For adding comment
Alexandra Chaton's avatar
Alexandra Chaton committed
20
* `[DOC]` For new documentation file or update of the documentation
Thomas Frion's avatar
Thomas Frion committed
21
22


Thomas Frion's avatar
Thomas Frion committed
23
### Branch name
Thomas Frion's avatar
Thomas Frion committed
24
25
26

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

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

Thomas Frion's avatar
Thomas Frion committed
29
### CHANGLOG
Thomas Frion's avatar
Thomas Frion committed
30

Thomas Frion's avatar
Thomas Frion committed
31
32
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.

Thomas Frion's avatar
Thomas Frion committed
33
### Issues
Thomas Frion's avatar
Thomas Frion committed
34
35
36
37
38
39

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
40
41
42
43
44
45
46
47
48
* `Bugs`          If this is a bug or any trouble

## Code

### Backend

#### API 

* If you add an new resource to the REST API, please create a new submodule with `$ python manage.py startapp <resource_name>`. You can use as sample the existing submodules.