Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.23 KB

rules.md

File metadata and controls

27 lines (19 loc) · 1.23 KB

Règles

Convention Git

  • Les libellés des commits doivent être rédigés en anglais sur un maximum de 80 caractères en démarrant par un verbe à l'infinitif

Conventions de programmation

  • Les identifiants doivent être en anglais
  • Les déclarations de variables locales se font sous le format abcDef
  • Les déclarations de variables globales se font sour le format AbcDef
  • Les déclarations de constantes se font sous le format ABC_DEF
  • Les déclarations de variables de classes se font sous le format abc_def
  • Les déclarations de fonctions se font sous le format AbcDef
  • Les commentaires doivent être rédigés en anglais
  • Le nom des fichiers se fait sous le format fichierFichier
  • Le placement des accolades se fait dans le style de Java if (...) {
  • Les indentations doivent être de taille 4 et utiliser

Questions et bugs

Les questions de compréhension et les signalements de bugs doivent être énoncés dans la section issues de Github avec un tag approprié.

Références, bibliographie, documents

Toutes les réféfences utiles au développement doivent être placées dans la section Wiki de Github. Chaque développeur est invité à partager ses connaissances dans cette même section.