Merge pull request #14 from ETS-TAF/feature/add_convention_doc

Add Convention_code_sheet

.gitignore

@@ -36,3 +36,4 @@ bin
 
 # local config
 application-local.yml
+node_modules

documentation/CONVENTIONS.md

@@ -0,0 +1,35 @@
+# TAF - Conventions d'écriture
+Dernière mise à jour : 16/10/2023
+
+---
+
+## TypeScript - Framework Angular
+- Noms des fonctions et variables en CamelCase : `thisIsAVariable`
+- Constantes en MAJUSCULE avec le mot clé `readonly` : `readonly VARIABLE_CONSTANTE: string = "const";`
+- Commentaires : `// + phrase en anglais` → `// this is a comment`
+- Code typé strictement
+- Appels API définis dans les services
+- Suivre les standards Angular : [Lien vers le guide de style Angular](https://angular.io/guide/styleguide)
+
+## Java - Framework Spring
+- Programmation orientée objet avec classes et interfaces
+- Utiliser le modèle MVC proposé par Spring (controller, services, repositories etc)
+- Noms des fonctions et variables en CamelCase : `thisIsAVariable`
+- Noms des classes, interfaces et énumérations en PascalCase : `ThisIsAClass`
+- Commentaires : `// + phrase en anglais` → `// this is a comment`
+- Constantes en MAJUSCULE avec le mot clé `final` : `final String VARIABLE_CONSTANTE = "const";`
+- Injection de dépendances de Spring, éviter d'utiliser 'new' pour instancier des dépendances
+- Suivre les conventions de programmation Java et Spring
+**Que ce soit pour le frontend ou le backend : les noms des variables, méthodes, classes, énumérations... doivent être explicites et définir le plus clairement possible leur fonction.**
+
+## GIT Flow
+- Message de commit sous la forme : "Action verb + élément concerné" écrit en anglais
+- Utiliser en majorité ces action verbs : Add, Fix, Remove, Update, Improve (toujours au présent)
+  -> `git commit -m "Add color enumeration"`
+- Un commit par changement
+- 3 types de branches :
+  - Main : branche de la version stable actuellement en production
+  - Develop : branche de la version en phase de test qui sert de référence aux branches feature
+  - Feature : branche créée pour ajouter une feature au programme. On la nomme : `feature/userstory_id-résumé_feature`
+- Fonctionnement : Pour créer une nouvelle feature il faut créer une branche depuis develop, une fois développée, il faut créer une pull request pour pouvoir merger la nouvelle feature sur develop
+