Commit 97cb18bc authored by Thomas Frion's avatar Thomas Frion
Browse files

Update CONTRIBUTING.md

parent e6e59422
# Contributing rules
## Commit name
## Git
### 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.
......@@ -17,21 +19,29 @@ Each commit must have a name that starts with the following elements:
* `[DOC]` For new documentation file or update of the documentation
## Branch name
### Branch name
A branch must be created by functionality, component, issue.
If the branch to be created is linked to an issue, then the name of the branch must start with the issue id.
## CHANGLOG
### CHANGLOG
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
### 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
* `Bugs` If this is a bug or any trouble
\ No newline at end of file
* `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.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment