jamespot-react-components 1.0.256 → 1.0.258

package/README.md

@@ -21,15 +21,59 @@ npm run build-storybook
 npm run local
 ```
 
-## Run tests
+## Tests et storybook
+
+Le storybook peut-être lancé avec la commande
+
+```
+pnpm storybook
 
 ```
-npm run storybook
 
-npm run test
-npm run test:watch
+Les composants sont répartis en deux grandes catégories dans le storybook: 1. untested/:
+Tous les composants dans untested/ sont exclus des tests storybook et doivent progressivement être migré vers RGAA et testé. 2. RGAA/:
+Les composants dans RGAA doivent aussi avoir le tag 'rgaa' dans leur story et doivent être testé.
+Toute story ayant le tag 'rgaa' sera exécuté comme test pendant les tests storybook,
+le coverage sera calculé et devra atteindre 100% pour les statements.
+Il est aussi attendu de ces composants qu'ils respectent au maximum les règles du RGAA pour l'accessibilité.
+N'hésitez pas à jeter un oeil aux composants déjà présents dans rgaa dans le storybook, à leurs stories
+et à la documentation de storybook pour écrire vos tests.
+
+Une fois le storybook lancé, les tests storybook peuvent être lancé avec la commande
+
+```
+pnpm test-storybook
+```
+
+/!\ LE STORYBOOK DOIT ETRE EN COURS D'EXECUTION /!\
+
+Si vous devez développer des utilitaires qui ne sont pas des composants react, ceux-ci doivent se trouver dans un dossier utils
+et faire l'objet de tests jest. Le coverage devra là aussi atteindre 100% pour les statements
+Les tests jest peuvent être exécutés avec la commande:
+
+```
+pnpm test
 ```
 
+Vous pouvez lancé l'ensemble des tests et voir le coverage total si le storybook est en cours d'exécution avec
+
+```
+pnpm test-all
+```
+
+Lors d'une merge request, le test-all sera exécuté, un coverage de 100% sera attendu avec tous les tests au vert.
+La même chose sera attendu lors de l'exécution de la pipeline pour une MEP.
+
+La ci utilisera la commande
+
+```
+pnpm test-ci
+```
+
+qui s'occupe de lancer le storybook puis de faire un test-all.
+Cette commande n'est pas adapté au développement local car elle arrête le storybook immédiatement après avoir
+terminé les tests.
+
 ## Contributing
 
 -   Les développements sont suivis sur le board [react-components](https://ecosysteme.jamespot.pro/ng/app/boardcard/167684) :