Skip to main content

Quick start : Synthèse et Principes Généraux d'un code de Qualité

🎯 Principes Généraux​

Code Fonctionnel et Stable​

  • Ne JAMAIS pousser du code qui ne compile pas
  • TOUJOURS tester localement avant commit
  • Suivre les patterns et conventions existants du projet
  • Respecter l'architecture établie

Responsabilités de l'Équipe​

  • Toujours commit son code et ses banches pour toutes ses branches
  • Code review obligatoire pour toutes les pull requests
  • Documentation des changements d'API publiques
  • Tests pour toutes les nouvelles fonctionnalités
  • Traçabilité des décisions techniques importantes

Pour chaque langage, vous trouverez le référentiel de coding :

📋 Standards de Code​

Conventions de Nommage​

Appliquer strictement les conventions de chaque langage : utiliser les guides de style établis (C# .NET, Angular, TypeScript/JavaScript)

Cohérence du Style​

  • Configurer et utiliser des outils de formatage automatique (Prettier, EditorConfig)
  • Respecter l'indentation et les espaces définies dans le projet
  • Maintenir une structure de fichiers cohérente
  • Suivre les patterns architecturaux du projet

Commentaires et Documentation​

Principes des commentaires efficaces :

  • Expliquer le POURQUOI, pas le quoi
  • Documenter les APIs publiques et interfaces
  • Annoter les algorithmes complexes et les décisions techniques
  • Maintenir les commentaires à jour avec le code
  • Éviter les commentaires redondants avec le code

Documentation technique :

  • XML Documentation pour les APIs C# (.NET) / Swagger
  • JSDoc pour TypeScript/JavaScript
  • Le wiki pour chaque module ou composant complexe
  • Exemples d'usage pour les fonctionnalités non-triviales

Architecture et Structure​

Respect des Patterns Établis​

  • Suivre l'architecture définie du projet (Clean Architecture, etc.)
  • Respecter la séparation des responsabilités
  • Maintenir la cohérence des couches applicatives
  • Éviter les dépendances circulaires et couplages forts

Organisation du Code​

  • Structurer les fichiers selon les conventions du projet
  • Regrouper les fonctionnalités connexes
  • Séparer les préoccupations métier, technique et infrastructure
  • Utiliser l'injection de dépendances appropriée

Gestion des Données​

Intégrité des Données​

  • Valider les données en entrée et sortie
  • Formater les données en entrée (trim...)
  • Définir des contraintes appropriées (clés, index, types)
  • Gérer les migrations de base de données de manière versionnée avec EF Core
  • Tester les changements de schéma en environnement de développement

Tests et Validation​

[Stratégie de Tests](Testing----Strategie-et-normes-des-Tests- -Solution-ABP- .NET- -Angular))​

Types de tests :

  • Tests unitaires : validation de la logique isolée
  • Tests d'intégration : interactions entre composants
  • Tests end-to-end : scénarios utilisateur complets
  • Tests de performance : pour les fonctionnalités critiques

Qualité des Tests​

  • Arrange-Act-Assert : structure claire des tests
  • Nommage explicite des cas de test
  • Isolation : tests indépendants entre eux
  • Données de test réalistes mais anonymisées
  • Couverture appropriée sans viser 100%

Sécurité​

Validation et Sanitisation​

  • Valider toutes les entrées utilisateur (côté client ET serveur)
  • Sanitiser les données avant traitement
  • Utiliser des bibliothèques de validation éprouvées (FluentValidation/GuardClauses ==> lib à définir TODO)
  • Implémenter une validation en profondeur ('defense in depth')

Protection des Données Sensibles​

  • Ne jamais stocker de mots de passe en clair
  • Toujours contrôler que les données fournies sont destinées à l'utilisateur final
  • Chiffrer les données sensibles au repos et en transit
  • Utiliser des algorithmes de hachage sécurisés (bcrypt, PBKDF2)
  • Gérer les secrets et clés API de façon sécurisée

Authentification et Autorisation​

  • Implémenter une authentification robuste
  • Contrôler l'accès aux ressources selon les permissions
  • Valider les tokens et sessions côté serveur
  • Configurer CORS de manière restrictive en production

Prévention des Vulnérabilités​

  • Prévenir l'injection SQL avec des requêtes paramétrées
  • Éviter les failles XSS en échappant les données
  • Limiter les attaques par déni de service (rate limiting)
  • Auditer régulièrement les dépendances pour les failles connues

⚡ Performance et Optimisation​

Optimisation des Requêtes​

  • Éviter les requêtes N+1 par des jointures appropriées
  • Utiliser la pagination pour les grandes listes de données
  • Implémenter des projections pour ne récupérer que les données nécessaires
  • Indexer les colonnes fréquemment interrogées

Gestion de la Mémoire​

  • Libérer les ressources appropriément (using, dispose)
  • Éviter les fuites mémoire avec des références circulaires
  • Utiliser le cache de façon judicieuse et avec expiration
  • Optimiser les allocations d'objets dans les boucles

Performance Frontend​

  • Lazy loading pour les composants non-critiques
  • Optimisation des re-rendus avec memoization
  • Compression des assets (images, scripts)
  • Code splitting pour réduire la taille des bundles

📖 Documentation et Communication​

Documentation du Code​

  • Documenter les APIs publiques et interfaces
  • Expliquer les algorithmes complexes et décisions techniques
  • Maintenir la documentation à jour avec le code
  • Fournir des exemples d'utilisation pour les fonctionnalités importantes

Documentation Technique​

  • README clair pour chaque module/composant
  • Guides d'installation et de configuration
  • Documentation d'API avec exemples de requêtes/réponses
  • Diagrammes d'architecture pour les systèmes complexes

Communication d'Équipe​

  • Documenter les décisions architecturales importantes (ADR)
  • Partager les bonnes pratiques découvertes
  • Signaler les problèmes et blocages rapidement
  • Effectuer des revues de code constructives

🚀 Livraison et Déploiement​

Configuration d'Environnement​

  • Séparer clairement les configurations par environnement
  • Utiliser des variables d'environnement pour les secrets
  • Valider la configuration au démarrage de l'application
  • Documenter les variables requises pour chaque environnement

Process de Livraison​

  • Automatiser les déploiements avec des pipelines CI/CD
  • Tester en environnement de staging avant production
  • Monitorer les déploiements avec des healthchecks
  • Prévoir des stratégies de rollback rapide

Outils et Ressources​

Outils Recommandés​

  • Linters et formateurs : ESLint, Prettier, ReSharper
  • Analyseurs de code : SonarLint, CodeQL
  • Tests d'API : Postman, REST Client, .http vs studio
  • Git : GitLens, conventionalcommits.org

Métriques et Monitoring​

  • Surveiller les performances et erreurs en production
  • Mesurer la couverture de tests et qualité du code avec Sonar
  • Analyser les logs pour identifier les problèmes
  • Alerter sur les métriques critiques

Processus de Code Review (si applicable)​

Critères de Review​

  • Fonctionnalité : le code fait-il ce qui est attendu ?
  • Architecture : respecte-t-il les patterns établis ?
  • Sécurité : y a-t-il des vulnérabilités potentielles ?
  • Performance : impact sur les performances existantes ?
  • Tests : couverture appropriée des nouveaux cas ?
  • Documentation : APIs et logique complexe documentées ?

Bonnes Pratiques de Review​

  • Reviewer rapidement (dans les 24h)
  • Feedback constructif avec suggestions d'amélioration
  • Approuver uniquement si prêt pour la production
  • Apprendre des reviews pour améliorer ses propres pratiques

Ce guide évolue avec l'équipe et les projets. Proposez vos améliorations via Pull Request.