C'est quoi une démarche qualité ?

[TheoDurr]

Outre la définition un très généraliste que l'on peut retrouver sur internet, le principe ici d'une démarche qualité est d'avoir une base de développement de de connaissances suivant des standards et des règles, pour veiller au bon déroulement de notre activité de développement. Elle est aussi visible auprès de l'utilisateur, qui en bénéficie tout autant de par son utilisation final de notre travail.

Toute cette démarche sera intégrée en continue dans le processus de développement, à l'aide de workflows de tests par exemple (test unitaires, formatage, règle de code, etc...).

Cela permet à l'ensemble des développeurs de pouvoir participer tout en gardant un ensemble cohérent et harmonieux 🌸

Les piliers de notre démarche qualité

Stabilité

Tests

🛠️ Unitaires

Ces tests sont primordiaux. Ils permettent d'éviter un quelconque effet de bord lors de l'ajout de nouvelles fonctionnalités. Ils testent chaque portion du code qui doit renvoyer un résultat bien défini (que chaque fonction renvoie le bon résultat en fonction de ses paramètres d'entrée par exemple).

En plus de tous ces tests, chaque fonctionnalité doit passer une phase de qualification. Elle est déployée sur un site parallèle à la production, et doit dérouler des cas de tests pour s'assurer du bon fonctionnement de l'évolution.

🤝 Intégration

Les tests d'intégrations font interagir les différents modules d'une application entre eux pour voir leur bonne coopération.

🔗 Bout en bout (e2e)

Ces tests vérifient le bon comportement d'une fonctionnalité entière, comme le bon comportement d'un endpoint de l'API. Combiné avec les autres tests, ils s'assurent que tout fonctionne parfaitement sans aucune régression.

🧪 Couverture des tests

Le taux de couverture du code en matière de tests doit être supérieur ou égal à 90% de tout le code de l'application. Sans cela, il vous sera impossible de déployer votre fonctionnalité.

Il est évident que tous les tests doivent aussi passer

Cohérence

📏 Règles de codage (linting)

En utilisant un Linter (un outil parcourant le code à la recherche d'éventuelles règles de code non respectées. Pour voir les règles, référez vous à la documentation de votre projet.

⌨️ Formatage

C'est souvent une petite commande rendant le code uniforme en matière de formatage. Se référer à la documentation de votre projet

Inclusivité

Termes non genrés

Voici quelques règles pour permettre aux projets une inclusivité totale :

1. Évitez d'utiliser des termes qui ont des antécédents sociaux. Les termes qui peuvent avoir une signification historique ou un impact en ce qui concerne la race, l'origine ethnique, l'origine nationale, le sexe, l'âge, les capacités mentales et physiques, l'orientation sexuelle, le statut socio-économique, la religion et les antécédents éducatifs.
2. Évitez d'utiliser des expressions idiomatiques et des jargons. Ceux-ci peuvent exclure les personnes qui n'ont pas de connaissances spécialisées particulières, et de nombreux expressions idiomatiques ne se traduisent pas d'un pays à l'autre. De plus, ceux-ci ont parfois leur origine dans des stéréotypes négatifs.
3. Écrivez des exemples inclusifs. Essayez d'éviter d'utiliser des exemples dans une documentation culturellement spécifique à un pays particulier, et assurez-vous d'utiliser des noms divers.
4. Si vous n'êtes pas sûr, demandez ! Essayez d'être conscient du choix de la langue et demandez si vous n'êtes pas sûr que certains phrasés puissent causer de l'inconfort.

🌍 Internasionalisation (i18n)

Dans une démarche d'accessibilité, le site de l'AE se doit d'être traductible dans plusieurs langues, afin de permettre à un maximum de personnes de l'utiliser. Pour cela, nous utiliserons la plateforme Crowdin de l'AE sur laquelle se trouveront l'ensemble des textes à traduire. Par défaut, l'ensemble des pages sont écrites en anglais, le français étant ainsi une langue secondaire qu'il faut traduire depuis Crowdin.

Accessibilité

🎨 Ergonomie et expérience utilisateur

Il n'y a pas de charte ergonomique, mais l'utilisation des composants déjà existants doit être une priorité pour offrir une uniformisation de l'interface graphique. Aussi, l'experience utilisateur doit être au centre de la réflexion lors de l'écriture de nouvelles pages.

📖 Documentation utilisateur

Un maximum de documenation doit être écrit en parallèle du développement afin que tous les outils publiés sur le site soient référencés et accessibles en cas d'incompréhension sur son utilisation.

✋🏻 Accessibilité

Toujours dans un soucis d'accessibilité, nous souhaitons rendre chaque page du site accessible aux personnes souffrant d'un handicap, c'est pourquoi chaque page du site devra
être navigable à la souris comme au clavier et devra présenter des aides pour les lecteurs
d'écran. De plus, il sera possible dans les réglages de changer le thème du site pour
une version plus adaptée aux personnes souffrant de troubles de la vision notamment le daltonisme.