@edugouvfr/ngx-dsfr-ext/CONTRIBUTING.md

NgxDsfrExt est une extension au package @edugouvfr/ngx-dsfr (portage Angular des éléments DSFR)

# @edugouvfr/ngx-dsfr-ext - Guide de contribution

## Tests E2E (end-to-end)

Les tests e2e de ce projet utilisent l'outil [Playwright](https://playwright.dev/). Ils assurent à la fois le bon fonctionnement et l'intégrité visuelle de ses composants.

Pour lancer la suite de test, utilisez la commande `npm run e2e:playwright:docker`.

Ces tests sont un préalable avant chaque fusion de branche. Veillez donc à vérifier que ces derniers sont valides avant de pousser votre contribution.

### Tests de regressions visuelles (VisReg)

Les tests de regressions visuelles sont identifiés par le tag @screenshot dans la suite de tests. En cas de modification
visuel d'un composant, il vous faudra recréer les nouvelles images de référence utilisées. Pour se faire, supprimez les images contenus dans le dossier `nom-du-composant.e2e.ts-snapshots` puis relancer la suite de tests VisReg à l'aide de la commande `npm run e2e:playwright:docker:visreg`. Les tests du composants en question seront alors en erreurs, mais de nouvelles images de références seront auto-générées dans le dossier mentionné plus haut. Il vous suffira ensuite de relancer cette même commande pour vérifier la bonne cohérence des images nouvellements créés.

En cas d'erreur sur l'un de ces tests, vous pourrez trouver le différentiel entre l'image réel et l'image attendu dans le dossier `test-results` à la racine de ce projet.