Workflow de développement

Statut : brouillon

Environnements

Environnement Usage
Boutique de développement Essais, données de test
Thème de prévisualisation Revue d'une branche
Boutique de production, thème publié Jamais modifié directement

Git

  • Branche main : toujours cohérente avec la boutique publiée.
  • Une branche par fonctionnalité : feat/F-010-selecteur.
  • Une PR = une fonctionnalité (ou un lot de doc). Elle met à jour la fiche (statut, section « Implémentation »).
  • Messages de commit : F-010: ajoute le filtrage par diagonale.

Boucle de travail (humain ou Claude Code)

  1. Choisir une fonctionnalité au statut valide.
  2. Lire la fiche, les règles, les ADR concernées.
  3. Écrire les tests depuis les exemples EX-xxx.
  4. Implémenter.
  5. Mettre à jour la doc.
  6. python scripts/check_docs.py et les tests.
  7. Prévisualiser sur le thème de développement, puis relire.

Vibe coding : règles d'usage

  • On ne démarre une session de code que sur une fiche valide.
  • On donne à l'agent la fiche, les BR et le CSV, pas toute la doc.
  • Relecture humaine complète obligatoire pour : prix, compatibilité, JSON-LD, texte juridique, paramètres de paiement et de taxes.
  • Quand l'agent hésite ou trouve une contradiction, il crée une entrée dans questions-ouvertes.md au lieu de choisir.
  • Toute décision prise pendant le code est reportée dans la doc avant la fin de la session.

Tests (stratégie)

Quoi Comment
Règles de compatibilité Tests unitaires sur le CSV (BR-001 à BR-006)
Cohérence prix configurateur / Shopify Test automatisé (EX-009)
JSON-LD Validation de schéma sur des pages de test
Accessibilité Vérification manuelle clavier + outil automatisé
Doc scripts/check_docs.py en intégration continue

Publication de la doc (ADR-010)

  • Le site est construit par Cloudflare Pages à chaque push : pip install -r requirements.txt && python scripts/check_docs.py && mkdocs build --strict, dossier de sortie site, variable PYTHON_VERSION=3.12.
  • Chaque branche a une URL de prévisualisation à partager à l'associé avant fusion. Cloudflare Access doit protéger le domaine de production et *.pages.dev.
  • Un lien mort ou une incohérence d'ID fait échouer le build : corriger, ne pas contourner.
  • Les IDs (BR-004…) sont reliés automatiquement par hooks/ids.py : ne pas écrire ces liens à la main.

Rédiger la doc

  • Liens entre fichiers : relatifs, avec l'extension .md (../01-catalogue/regles-metier.md).
  • Images : dans docs/assets/img/<section>/, noms en minuscules sans espaces, fichiers légers ; syntaxe ![description](../assets/img/x.png){ width="400" }. Schémas modifiables : exporter en SVG.
  • Diagrammes : bloc de code de langage mermaid (texte versionné), à garder étroit pour la lecture sur mobile.
  • Données CSV : affichées par le plugin table-reader, voir l'exemple dans docs/01-catalogue/compatibilite.md (chemin relatif à docs/).
  • Compte-rendu de réunion : copier docs/10-reunions/_gabarit-cr.md (voir Réunions).

Commandes

pip install -r requirements.txt   # une fois (idéalement dans un venv)
python scripts/check_docs.py
mkdocs serve
shopify theme dev