Aller au contenu

Nommer le reste

CSS, scripts, variables d'environnement, branches, commits, modules, plugins et portes.

Voir en Markdown

Les statuts de chaque règle sont expliqués dans « Nommer les choses ».

NOM-AUTRE-01 · Nommez une classe ou une variable CSS en kebab-case, par son rôle

Section intitulée « NOM-AUTRE-01 · Nommez une classe ou une variable CSS en kebab-case, par son rôle »
À éviter
.bleu-gras { color: #3566e8; }
.mt-3-custom { margin-top: 13px; }
À faire
.tete-de-fiche { color: var(--bleu); }
.bandeau { margin-top: var(--espace-3); }

Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.

À décider Quelques variables sont en anglais (--muted, --surface) dans une famille française : n’en créez pas de nouvelle.

Voir aussi. L’échelle fermée

NOM-AUTRE-02 · Nommez un script par un verbe, dans la casse de son langage

Section intitulée « NOM-AUTRE-02 · Nommez un script par un verbe, dans la casse de son langage »
À éviter À faire
VerifierRoutes.mjs, verifier_les_routes.mjs verifier-les-routes.mjs
CorrectionsConnues.py corrections_connues.py

À décider Un dossier mélange aujourd’hui les deux casses pour Python.

NOM-AUTRE-03 · Préfixez une variable d’environnement du nom du projet

Section intitulée « NOM-AUTRE-03 · Préfixez une variable d’environnement du nom du projet »
À éviter À faire
BASE, SORTIE Le préfixe du projet devant le nom
NEXT_PUBLIC_SERVICE_KEY ANTHROPIC_API_KEY, jamais exposée au navigateur

Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.

Exception. Un fichier d’exemple liste tous les noms, sans valeur.

NOM-AUTRE-04 · Nommez une branche par son sujet, en kebab-case

Section intitulée « NOM-AUTRE-04 · Nommez une branche par son sujet, en kebab-case »
À éviter À faire
ma-branche, test2, fix heures-supplementaires
Une branche pour un correctif d’une ligne Un commit sur main

À décider Aucun texte ne fixe la forme du nom d’une branche.

NOM-AUTRE-05 · Écrivez un commit type(domaine): ce que ça fait

Section intitulée « NOM-AUTRE-05 · Écrivez un commit type(domaine): ce que ça fait »
À éviter À faire
fix: bug, updates, wip fix(facturation): ne plus compter deux fois une facture partagée
Un domaine inventé à chaque commit Le domaine en un mot : planning, base, ecrans

Règle écrite Écrite dans le guide de contribution ; un crochet vérifie la forme du message.

NOM-AUTRE-06 · Nommez un module par le code de la table module

Section intitulée « NOM-AUTRE-06 · Nommez un module par le code de la table module »
À éviter À faire
modules/Habilitations/index.ts modules/habilitations/module.ts qui exporte habilitations

Règle écrite Décidé ; aucun module n’est encore livré dans le code.

Voir aussi. Les portes

NOM-AUTRE-07 · Nommez un plugin par son nom, hors du dépôt du produit

Section intitulée « NOM-AUTRE-07 · Nommez un plugin par son nom, hors du dépôt du produit »

Règle écrite Décidé dans les décisions sur les modules et les plugins.

Voir aussi. Les plugins

NOM-AUTRE-08 · Versionnez une porte et nommez ses emplacements en minuscules à tirets

Section intitulée « NOM-AUTRE-08 · Versionnez une porte et nommez ses emplacements en minuscules à tirets »
À éviter À faire
ficheEmploye, fiche_employe fiche-employe

Les emplacements décidés : fiche-employe, fiche-operation, fiche-affaire, fiche-client, planning-marques, planning-cartes, cloche, recherche.

Règle écrite Décidé ; la version d’une porte n’est pas encore dans le code.

Règle À retenir Tenue par
NOM-AUTRE-01 Nommez une classe ou une variable CSS en kebab-case, par son rôle Usage constaté, À décider
NOM-AUTRE-02 Nommez un script par un verbe, dans la casse de son langage À décider
NOM-AUTRE-03 Préfixez une variable d’environnement du nom du projet Usage constaté
NOM-AUTRE-04 Nommez une branche par son sujet, en kebab-case À décider
NOM-AUTRE-05 Écrivez un commit type(domaine): ce que ça fait Règle écrite
NOM-AUTRE-06 Nommez un module par le code de la table module Règle écrite
NOM-AUTRE-07 Nommez un plugin par son nom, hors du dépôt du produit Règle écrite
NOM-AUTRE-08 Versionnez une porte et nommez ses emplacements en minuscules à tirets Règle écrite