les-3-fantastiques-V2 / grade_de

1 stars 0 forks source link

PROJET




REGLEMENTATION

SOMMAIRE



>> BRANCHE

>> COMMIT

>> FICHIER






Branche

Construction :

{TYPE}/{NOM}
Reference Contenu Obligatoire
{TYPE} Voir tableau type OUI
{NOM} Nom décrivant la branche OUI



Type

Terme Utilisation Exemple
ADD Ajout de contenu ADD/start-loader
FIX Fix de problèmes FIX/generation-problem
REFACTO Restructuration du code REFACTO/using-correct-type



Langue : Anglais






COMMITS

Construction :

[{TYPE}] : {SOMMAIRE}
>> {DESCRIPTION}
Reference Contenu Obligatoire
{TYPE} Voir tableau type OUI
{SOMMAIRE} Petit sommaire du commit OUI
{DESCRIPTION} Description complète du commit NON



Type

Terme Utilisation Exemple
ADD Ajout de contenu [ADD] : Loader at start
DEL Suppression de contenu [DEL] : Old Feature
FIX Fix de problèmes [FIX] : Generation error
REFACTO Restructuration du code [REFACTO] : Using correct type
MOD Modification d'un contenu [MOD] : Rules of README
CLEAN Nettoyage d'un contenu [CLEAN] : Unused old files



Langue : Anglais



Exemple de Commits :

[ADD] : Project Setup
>> Adding README and .gitignore files






FICHIER

Modèle de nom des fichiers / dossier : camelCase

camelCase :

  • Pas d'espace
  • Première lettre en minuscule
  • Première lettre de chaque mot en majuscule
  • Pas d'accent

Exemple : nomDeFichier.c

Modèle de nom des fonctions : camelCase

camelCase :

  • Pas d'espace
  • Première lettre en minuscule
  • Première lettre de chaque mot en majuscule
  • Pas d'accent

Exemple : nomDeFonction

Modèle de nom des structures : PascalCase

PascalCase :

  • Pas d'espace
  • Première lettre en minuscule
  • Pas d'accent

Exemple : NomDeStructure