mirror of
https://framagit.org/la-chariotte/la-chariotte.git
synced 2025-05-01 11:22:24 +02:00
Update file README.md
This commit is contained in:
parent
72386c387f
commit
b96ef1408d
1 changed files with 25 additions and 0 deletions
25
README.md
25
README.md
|
@ -21,6 +21,31 @@ Ensuite, un mainteneur de la Chariotte pourra relire votre code et proposer des
|
||||||
|
|
||||||
Encore merci, et bon code !
|
Encore merci, et bon code !
|
||||||
|
|
||||||
|
### Conventions de nommage
|
||||||
|
|
||||||
|
Chaque branche doit être nommée sous la forme `[category]/[description]`
|
||||||
|
*category* détermine le type de modification que vous comptez effectuer au sein de la branche :
|
||||||
|
- `feature` pour ajouter une fonctionnalité au projet$
|
||||||
|
- `fix` pour corriger un bug
|
||||||
|
- `test` pour effectuer des changements n'étant associé à aucun besoin déjà spécifié
|
||||||
|
- `doc` pour effectuer des changements relatifs à la documentation (readme notamment)
|
||||||
|
- `refactor` pour effectuer un changement au sein du code sans conséquence sur l'application
|
||||||
|
|
||||||
|
Vous pouvez ajouter une catégorie si le besoin s'en fait sentir, tout en s'assurant que le sens soit bien compréhensible de l'extérieur
|
||||||
|
|
||||||
|
Les noms des branches, en anglais et en kebab-case, doivent décrire de manière très succinte l'objectif de la branche : dans quel but elle a été créée sans entrer dans le détail.
|
||||||
|
Bons exemples :
|
||||||
|
- `feature/improve-pdf-generation`
|
||||||
|
- `fix/deadline-increments-on-duplicated-commands`
|
||||||
|
- `doc/explain-conventions`
|
||||||
|
- `refactor/is_ongoing-to-is_open`
|
||||||
|
|
||||||
|
Mauvais exemples :
|
||||||
|
- `fix-some-stuff`
|
||||||
|
- `readme`
|
||||||
|
- `feature/add-a-cool-ui-element-when-the-cursor-passes-over-the-calendar-where-the-user-can-also-choose-the-associated-hour`
|
||||||
|
- `fix/edit-order/views/order.py-to-replace-is_ongoing-by-is_open`
|
||||||
|
|
||||||
## Versions - semantic versionning
|
## Versions - semantic versionning
|
||||||
|
|
||||||
Les fonctionnalités développées dans les différentes versions sont listées dans le fichier [CHANGELOG.md](https://gitlab.com/hashbangfr/la_chariotte/-/blob/main/CHANGELOG.md).
|
Les fonctionnalités développées dans les différentes versions sont listées dans le fichier [CHANGELOG.md](https://gitlab.com/hashbangfr/la_chariotte/-/blob/main/CHANGELOG.md).
|
||||||
|
|
Loading…
Reference in a new issue