From f2bee54ab2ec4d0d07702e180e6717dbdb56cc57 Mon Sep 17 00:00:00 2001 From: felix Date: Mon, 16 Oct 2023 17:41:59 -0400 Subject: [PATCH 1/2] Add Convention_code_sheet --- .gitignore | 1 + documentation/Code_Conventions.md | 35 +++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 documentation/Code_Conventions.md diff --git a/.gitignore b/.gitignore index 411dfbd..dbb5e35 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,4 @@ bin # local config application-local.yml +node_modules diff --git a/documentation/Code_Conventions.md b/documentation/Code_Conventions.md new file mode 100644 index 0000000..6ef5d1d --- /dev/null +++ b/documentation/Code_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` → `// Ceci est un commentaire` +- 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` → `// Ceci est un commentaire` +- 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 + -> `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 + From e1726e79d779de33f7ab32168e0c8dbd01122daf Mon Sep 17 00:00:00 2001 From: felix Date: Thu, 19 Oct 2023 16:16:53 -0400 Subject: [PATCH 2/2] fix CONVENTION.md --- documentation/{Code_Conventions.md => CONVENTIONS.md} | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) rename documentation/{Code_Conventions.md => CONVENTIONS.md} (91%) diff --git a/documentation/Code_Conventions.md b/documentation/CONVENTIONS.md similarity index 91% rename from documentation/Code_Conventions.md rename to documentation/CONVENTIONS.md index 6ef5d1d..03222e0 100644 --- a/documentation/Code_Conventions.md +++ b/documentation/CONVENTIONS.md @@ -6,7 +6,7 @@ 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` → `// Ceci est un commentaire` +- 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) @@ -16,7 +16,7 @@ Dernière mise à jour : 16/10/2023 - 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` → `// Ceci est un commentaire` +- 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 @@ -24,7 +24,7 @@ Dernière mise à jour : 16/10/2023 ## 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 +- 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 :