Conventions de codage
Ceci est un recueil des conventions de codage que nous utilisons dans O3. L’objectif de ce document est de nous aider à écrire du code cohérent et facile à maintenir.
Ces conventions représentent notre expérience collective et les meilleures pratiques pour créer des applications frontend maintenables, performantes et conviviales dans l’écosystème OpenMRS 3.x. Elles couvrent tout, de la nomenclature et de la structure du projet à la gestion de l’état et à l’optimisation des performances.
À qui s’adresse ce guide ?
- Nouveaux contributeurs cherchant à comprendre nos standards de codage
- Développeurs existants recherchant des conseils sur des modèles d’implémentation spécifiques
- Réviseurs référençant les standards lors des revues de code
- Chefs techniques prenant des décisions architecturales
Comment utiliser ce guide
Ce document sert à la fois de référence et de ressource d’apprentissage. Bien que vous devriez viser à suivre ces conventions dans votre code, comprenez qu’il s’agit de lignes directrices plutôt que de règles strictes. L’objectif est de maintenir la cohérence tout en écrivant du code de haute qualité et maintenable.
Si vous trouvez des cas où s’écarter de ces conventions donnerait un meilleur code, n’hésitez pas à en discuter avec l’équipe. Nos conventions évoluent au fur et à mesure que nous apprenons et que les meilleures pratiques de l’écosystème frontend changent.
Table des matières
- Structure du projet
- Organisation du code
- Nommage
- Composants
- Annotations de type
- Gestion de l’état
- Récupération des données
- États de chargement
- Mutations et effets secondaires
- Gestionnaires d’événements
- Formulaires
- Espaces de travail
- Modales
- Styles
- Champs de recherche
- Internationalisation
- Gestion des erreurs
- Tests
- Performance