3.5 KiB
Onboarding guide: agents IA + architecture + tests
Ce guide est optimise pour accelerer la prise en main des agents IA (Copilot, Plan, Explore) dans Yavsc, avec une verification rapide par les tests.
Resultat attendu
A la fin du parcours, un contributeur doit pouvoir:
- Identifier les projets impactes par une modification.
- Choisir l'agent adapte a l'intention de travail.
- Produire une proposition de changement verifiable par les tests.
Parcours en 3 modules
Module A - Comprendre le terrain (30-45 min)
Objectif: acquerir une lecture fiable de l'architecture.
- Lire README.md puis Architecture.md.
- Lire architecture/decoupage-organisation.md.
- Selon le domaine:
- Backend/API: architecture/workflow-multi-parties.md
- PostIt: architecture/postit.md puis architecture/postit-oidc.md
Definition of done:
- Expliquer en 5 phrases quelles couches sont touchees.
- Citer le ou les points d'entree applicatifs a verifier.
Module B - Boucle tests rapide (20-30 min)
Objectif: verifier rapidement sans lancer toute la suite.
- Lire testing.md.
- Lancer les smoke tests d'abord, puis mandatory selon le projet.
- N'elargir au test complet que si le scope depasse le BC touche.
Definition of done:
- Fournir la commande test executee.
- Expliquer pourquoi ce niveau de test est suffisant.
Module C - Usage agentique en production (30-40 min)
Objectif: utiliser les agents comme accelerateurs, pas comme boites noires.
- Plan: decomposer la tache en etapes verifiables.
- Explore: collecter le contexte code/doc precise.
- Copilot: implementer localement et verifier.
Regles:
- Toujours donner un contexte explicite (fichier, but, contrainte).
- Demander des preuves observables (fichiers modifies, tests, risques).
- Refuser toute sortie non verifiable.
Definition of done:
- Une tache simple est livree avec:
- Plan
- Changement local
- Preuve par test
Routine continue (sans echeance fixe)
Rituels recommandes:
- Hebdo: revue des prompts qui ont bien fonctionne.
- Mensuel: mise a jour du present guide et du playbook.
- A chaque incident: ajouter un anti-pattern dans le playbook.
Reseau de versionnement / git flow pour le CHANGELOG
Regle obligatoire:
- La section courante du CHANGELOG représente la prochaine version a publier, pas un tag deja créé.
- Un tag deja publie bloque définitivement la section correspondante du CHANGELOG.
- Au commit suivant, si la modification impacte le CHANGELOG, il faut incrémenter la version exposée dans le changelog (version du prochain tag attendu), par exemple:
1.0.8-rc30 -> 1.0.8-rc31.
Ordre a respecter a chaque commit qui modifie le produit:
- Verifier si le dernier tag du CHANGELOG existe deja; si oui, incrémenter la version de la section suivante au lieu de re-écrire la dernière section bloquée.
- Ouvrir une nouvelle section du CHANGELOG avec ce numero de version incrémenté.
- Apres seulement, alimenter cette section avec la description du changement.
En pratique: la version du CHANGELOG est la version "future" a tagger, et elle est incrémentée avant l'écriture de la description; le tag n'est pas créé avant la section, il est seulement établi ensuite lors de la publication effective.
Check-list de validation
- Le changement indique son impact architecture.
- Le choix de l'agent est justifie.
- La preuve test est incluse.
- Les risques residuels sont explicitement listes.