Conventions de nommage - MelvinCou/cash-manager GitHub Wiki

Sources :

Créer une branche ?

<type>/<issue_ID>-<name>

Les types de branche :

- feature: Ajout d’une nouvelle fonctionnalité;

- bugfix: Correction d’un bug;

- hotfix: Correction d’un bug critique;

- chore: Nettoyage du code;

- experiment: Expérimentation de fonctionnalités.

Le nom de la branche décrit succinctement le but de celle-ci. Certaines règles doivent être respectées :\

- Le nom doit faire moins de 50 caractères;
- Le nom doit respecter la convention kebab-case (les mots doivent être en minuscule et liés par des tirets “-“);

Le reste fait référence au numéro du ticket (issue)

Quelques exemples \

feature/27-add-users-controller

hotfix/621-profile-page-error/

experiment/63-try-api-key

chore/924-remove-deprecated-method

Nommer ses commits?

Le format

<type>(<portée>): <sujet>

<description>

<footer>

Les types :

  • build: Système de build (example : gulp, webpack, npm)
  • ci: Intégration continue (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation
  • feat: Ajout d'une fonctionnalité
  • fix: Correction de bogue
  • perf: Amélioration des performances
  • refactor: Changement du code qui ne change rien au fonctionnement
  • style: Changement du style du code (sans changer la logique)
  • test: Modification des tests

Portée définit quelle partie de votre librairie / application est affectée par le commit (cette information est optionnelle)

Sujet contient une description succinte des changements,

En utilisant l'impératif présent ("change", et non pas "changed" ou "changes") Sans majuscule au début
Pas de "." à la fin de la description

Description permet de détailler plus en profondeur les motivations derrière le changement.
Les règles sont les mêmes que pour la partie Sujet.

Exemple :

git commit -m 'Infinite loop when pressing Alt-F4

This was caused by a missing check in the event loop
The program now checks when the window is set to close

Linked #101'
⚠️ **GitHub.com Fallback** ⚠️