Aller au contenu
Retour au blog

Les décisions d'architecture vivent avec le code

B Benoît H. Dicaire
·2 min de lecture
Partager :

Une page de setup devrait dire à l’opérateur quoi faire.

Elle ne devrait pas porter toute l’histoire du Worker, de l’installateur, du schéma, de l’automatisation de release et des règles de sécurité runtime. Cette histoire reste importante. Elle appartient pres de l’implementation.

vanityURLs garde les décisions produit dans des architecture décision records dans le dépôt code. Les docs publiques restent opérationnelles. Le dépôt code garde le raisonnement dont les futurs mainteneurs auront besoin lorsque le prochain changement semble évident, mais ne l’est pas.

Ce Qui Merite Un ADR

Un ADR documente une décision qui serait couteuse a redecouvrir.

De bons candidats :

  • l’automatisation avec release-please et le versionnement semantique
  • la frontiere de propriété entre defaults/ et custom/
  • quand schema_version change et quand un champ additif va seulement dans le changelog de schéma
  • comment setup crée les fichiers de départ
  • pourquoi une règle de sécurité runtime à une portee etroite

Les ADR n’ont pas de standard canonique unique. vanityURLs suit la convention pratique : fichiers numerotes courts, décision, contexte qui l’a forcee, et consequence acceptee par le projet.1

Pourquoi Le Depot Code

La décision appartient la ou l’implementation change.

Si un commit modifie scripts/setup.mjs, defaults/v8s-site-config.json et une règle de schéma, l’ADR peut voyager avec ce commit. Les reviewers voient le code et la raison ensemble.

Cela garde le site public plus court. Le site peut dire quoi faire. L’ADR peut conserver pourquoi le produit fonctionne ainsi.

Ou Regarder

Les ADR vivent dans le dépôt code sous docs/adr/.

Les ajouts de champs de schéma sont suivis dans docs/schema-changelog.md, surtout lorsque le changement est additif et ne change pas schema_version.

Le compromis est l’indirection. Un utilisateur peut devoir suivre un lien vers GitHub pour lire tout le raisonnement. C’est mieux que transformer chaque page de setup en couche archeologique.


  1. L’organisation publique ADR GitHub est un point d’entree utile, mais les ADR du dépôt sont l’autorite locale. ↩︎

Modifier cette page Dernière modification:

Plus d'articles