# 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 or for an update of a file (not source code)
* `[CPNT]` For a new component
* `[UPDF]` For a feature update
* `[UPDC]` For a feature component
* `[FIX]`  For a bug fix
* `[CLEAN]` For refactoring or deleting unnecessary comments
* `[COMMENT]` For adding comment
* `[DOC]` For new documentation file or update of the documentation


## 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

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