Skip to content

Tenir les journaux de changements ​

Sources et responsabilités ​

  • packages/<paquet>/CHANGELOG.md est la source du journal du paquet : une section par version, puis des groupes de composants ou d’API.
  • Le CHANGELOG.md à la racine donne la vue de la livraison et renvoie aux détails ; il ne duplique pas les descriptions de chaque composant.
  • Les blocs de changelog des README de paquets sont générés par pnpm sync:changelogs. Ne pas les modifier séparément.
  • Le backlog décrit le statut, les validations restantes et les évolutions proposées ; il renvoie aux journaux pour les changements terminés.
  • La matrice web/mobile mesure la couverture des responsabilités, pas le nombre d’exports ni une parité de toutes les props.

Écrire une note utile ​

Nommer le composant ou la fonction, le comportement ajouté/corrigé, puis son utilité. Mentionner les limites et migrations nécessaires. Décrire le résultat final d’un même composant une seule fois dans une livraison, même si plusieurs commits l’ont fait évoluer.

Exemple : « Spinner, double-ring — anneau intérieur en retrait de 16 %, opacité 0,5 ; rend les deux anneaux distincts. Les rotations opposées sont conservées. »

Ne pas employer le nom d’une application consommatrice, un numéro de lot interne ou « améliorations diverses » comme explication. Ne pas présenter un exemple de démo comme un export public. Une fiche regroupant des alias doit les nommer. Une version alignée sans changement fonctionnel doit le dire explicitement.

Du changement à la livraison ​

Créer un changeset par paquet concerné lorsque les descriptions diffèrent : une note commune est sinon copiée à l’identique dans plusieurs journaux. Au moment de regrouper, conserver le niveau le plus fort requis par chaque paquet et comparer les plans avant/après avec pnpm changeset status --output=<fichier>.

pnpm changeset:version applique les versions, consomme les notes, génère les journaux, synchronise les README et actualise le lockfile. Ce n’est pas une publication. Le groupe fixed explicite de .changeset/config.json aligne les dix paquets publics ; les dépendances peuvent imposer un alignement même sans nouvelle API propre au paquet.

Avant la publication, relire la section générée, regrouper les descriptions par composant et supprimer les répétitions de dépendances. Conserver les sections historiques ; corriger une attribution trompeuse en expliquant la portée réelle, sans déplacer une fonction dans une autre version. Synchroniser ensuite les README.

Cas du registre ​

Le paquet et ses entrées copiables ont des versions distinctes. Dans son journal :

  • conserver un seul titre ## x.y.z par version ;
  • écrire les entrées en puces de premier niveau sous la forme - `sidebar` — changement et utilité ;
  • garder les notes historiques des entrées, même si le paquet suit le groupe fixed ;
  • distinguer les notes du paquet des notes des fichiers copiables ; publier le paquet ne met pas automatiquement à jour une copie dans une application.

Contrôles de la documentation de release ​

bash
pnpm sync:changelogs
node scripts/sync-package-changelogs.mjs --check
pnpm check:changelog
pnpm check:registry-versions
pnpm check:deps
pnpm check:license
pnpm build

La vérification du registre contrôle la présence des entrées/version, pas la justesse de la phrase. La relecture doit comparer chaque note au code et à l’historique. Une compilation ou un export Expo ne remplace pas les tests sur appareil ; consigner séparément les validations encore nécessaires.

Publié sous licence MIT.