Skip to content

Instantly share code, notes, and snippets.

@guilmarc
Last active March 15, 2024 16:56
Show Gist options
  • Save guilmarc/81e429990b467b15c314598899e56d1f to your computer and use it in GitHub Desktop.
Save guilmarc/81e429990b467b15c314598899e56d1f to your computer and use it in GitHub Desktop.
Coding Convention

Attention : Pénalité par convention de code non respectée

Conventions fonctionnelles

  • Aucun console.log() dans le code.
  • Aucun warning ni erreur dans la console du navigateur.
  • Le front-end doit obligatoirement utliser le port 9000.
  • Le back-end doit obligatoirement utiliser le port 3000.
  • À moins d'une exception expliquée dans le code, tous les styles doivent être en BootStrap.

Conventions de code

  • Tous les composants doivent avoir un entête incluant le rôle principal du composant ainsi que la liste des propriétés et leur raison d'être, incluant les variable appropriés en JSDoc.

  • Toutes les fonctions doivent être documentées correctement en JSDoc.

Section script

Élément Précision Exemple
Paramétrage CompositionAPI en Typescript <script setup lang="ts">
Variables CamelCase const localGrids = ..

Section template

Élément Précision Exemple
Tags natifs Minuscule <body>
Directives Vue KebabCase <div v-model="currentGrid"
Composants KebabCase <mon-composant />

Section style

Travailler le style le plus possible avec Bootstrap et pour les besoins particulier, utilisez SASS.

<style scoped lang="sass">

Convention d'architecture

Front-End

  • Suivre les conventions de Vue 3.3.
  • Suivre les conventions de Vue 3.4.
  • Avoir un fichier d'indexage pour chaque répertoire de code (index.ts) et faire les imports de ce fichier.

Back-End

  • Permettre aux queries ou tout autre appels directs à la base de données d'être utilisées en mode asynchrone.
  • Avoir un fichier d'indexage pour chaque répertoire de code (index.js) et faire les imports de ce fichier.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment