Règles de développement
Les règles strictes du code, de la base, de l'interface, des textes et des secrets, une page par domaine.
Ces règles valent pour toutes les équipes, personnes ou agents. Lisez celles qui touchent ce que vous changez, et seulement elles.
Comment lire une règle
Section intitulée « Comment lire une règle »Chaque règle suit le même modèle.
| Élément | Ce que c’est |
|---|---|
| Identifiant | CODE-01, BASE-05… Il sert à citer une règle dans une relecture ou une consigne. |
| Titre | Un ordre, à l’impératif : « Lisez la base une seule fois par écran ». |
| Règle | L’énoncé en une ou deux phrases, dans l’encadré vert. |
| Pourquoi | Ce que la règle évite. |
| À éviter, à faire | Le même cas, mal puis bien. |
| Tenue par | Qui la fait respecter. |
| Exception, voir aussi | Quand elle ne s’applique pas, et où lire la suite. |
Qui tient une règle
Section intitulée « Qui tient une règle »Outil Un script, un test ou un contrôle échoue si on enfreint la règle. Vous n’avez pas à la retenir.
Relecture Aucun outil ne la vérifie. Les relecteurs la couvrent, et elle n’est pas facultative pour autant.
Règle écrite Décidée et écrite dans un document du projet.
Usage constaté Le dépôt la suit presque partout, aucun document ne la décide encore. Suivez-la.
À décider Le dépôt hésite entre deux formes. Ne tranchez pas seul : demandez.
Toutes les règles tiennent dans un seul tableau.