CONTRIBUTING.md 1.8 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
* `[WIP]` For Work in progress. Use it to make a save of your work, or if no flag above match with your commit
Alexandra Chaton's avatar
Alexandra Chaton committed
18
* `[DOC]` For new documentation file or update of the documentation
Thomas Frion's avatar
Thomas Frion committed
19 20 21
* `[CLEAN]` For refactoring or deleting unnecessary comments
* `[COMMENT]` For adding comment
* `[TEST]` For adding or update of unit tests
Thomas Frion's avatar
Thomas Frion committed
22 23


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

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

Thomas Frion's avatar
Thomas Frion committed
28 29
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
30
### CHANGLOG
Thomas Frion's avatar
Thomas Frion committed
31

Thomas Frion's avatar
Thomas Frion committed
32 33
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
34
### Issues
Thomas Frion's avatar
Thomas Frion committed
35 36 37 38 39 40

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

## Code

Thomas Frion's avatar
Thomas Frion committed
45 46
At any time, if you need help you can read our [wiki](https://gricad-gitlab.univ-grenoble-alpes.fr/Projets-INFO4/19-20/8/app-pghm/-/wikis/home)

Thomas Frion's avatar
Thomas Frion committed
47 48 49 50 51
### 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.