Convention de nommage des branches et des commits - MelvinCou/Coffee-Show-Up GitHub Wiki

Nommage des branches

Nommez la branche selon ce schéma : [type]/[issue-numero]-[issue-name].

Les types de branches :

  • feat: Ajout d’une nouvelle fonctionnalité;

  • fix: Correction d’un bug;

  • hotfix: Correction d’un bug critique;

  • chore: Nettoyage du code;

  • release: Branche de recette

  • refactor: Refactorer du code

  • config: Ajouter/Modifier des fichiers de configuration

  • test: Ajout/Modification de tests

Quelques exemples :

feat/27-add-users-controller

hotfix/621-profile-page-error/

experiment/63-try-api-key

chore/924-remove-deprecated-method

Nommer un commit

Le format :

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

<description>

<footer>

Les types de commit :

  • build: Système de build (example : gulp, webpack, npm)

  • ci: Intégration continue (example scopes: Travis, Circle, BrowserStack, SauceLabs)

  • config: Fichiers de configuration

  • docs: Documentation

  • feat: Ajout/Continuité d'une fonctionnalité

  • wip: Commit d'un code nécessaire à la release, mais qui devra être retravaillé par la suite

  • fix: Correction de bug

  • hotfix: Correction d'un bug critique

  • perf: Amélioration des performances

  • refactor: Changement du code qui ne change rien au fonctionnement

  • chore: Supprimer du code inutilisé

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

Le 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 et pas de "." à la fin de la description.

La 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.

Review des pull requests

La ou les personnes désignées pourront faire la review de la pull request d'un des collaborateurs. Elle concernera le code, mais aussi le bon fonctionnement de l'application. Les régressions éventuelles devront être détectées lors de cette review. Vous pourrez vous baser sur la fiche suivante pour voir les différentes fonctionnalités en place, et noter les éventuels bug détectés. Fiche Review

⚠️ **GitHub.com Fallback** ⚠️