29 lines
699 B
Markdown
29 lines
699 B
Markdown
# Contributing rules for the repository
|
|
|
|
To contribute into the current repository <TODO complete url>, you should follow these rules.
|
|
|
|
## Languages
|
|
|
|
1. the language used for comments and code is English.
|
|
2. the prefered language for issues and pull-request is English but French is accepted.
|
|
|
|
## Structure of the code
|
|
|
|
... rules to follow to COMPLETE
|
|
|
|
## Maintainers
|
|
|
|
Current maintainers of this repository are :
|
|
- to complete
|
|
|
|
## Commits
|
|
|
|
- define rules abour commits
|
|
|
|
## Branch names
|
|
|
|
- for a new feature, `feat/my-feature`
|
|
- for a fix, or an improvement of a feature, `fix/my-feature-name`
|
|
- for a bugfix, `bugfix/bug-name`
|
|
- banches are refernced to a version named branch as `v1.x.x`
|