Ce repo contient la liste des standards exigés des produits Beta.
À chaque règle correspond un fichier Markdown. Elles sont organisées par dossier pour chaque domaine correspondant (accessibilité, qualité logicielle, etc).
Elles suivent un format simple décrit dans le standard modèle, et leur contenu doit suivre nos règles typographiques.
Le nom du fichier doit refléter le nom de la règle, par exemple :
# L'équipe mange à la cantine
[...]doit correspondre au fichier l-equipe-mange-a-la-cantine.md. Le nom
du fichier peut être automatiquement ajusté avec la commande make fix-filenames.
Des règles automatiques sont en place sur les fiches grâce au linter markdownlint qui garantit par exemple que :
- les titres ne finissent pas par des points
- le corps de texte ne dépasse pas 80 caractères
- les marqueurs de liste sont homogènes
- etc.
Vous pouvez consulter la liste des règles et installer une extension pour votre éditeur.
Deux extensions sont automatiquement recommandées pour les utilisateurs de VSCode : le linter ainsi qu'un plugin qui permet d'aligner le texte sur 80 colonnes (avec la commande Alt-Q).
Pour lancer le linting :
make lintUn script est disponible pour exporter tous les standards dans un
format YAML "machine-readable" avec la commande make export.
Vous pouvez consulter des examples d'export sur la page des versions du projet.
- remplir les descriptions : pourquoi règle X ? peut-être même une checklist pour vérifier façon WCAG)
- enlever les questions trop floues (i.e "le service est frugal" pas facile à vérifier)
- rajouter des propriétés