Princesseuh
commented
4 years ago Également, il serait pertinent de documenter la structure du repo. Ce n'est pas vraiment pertinent de documenter les fichiers individuellement en détail - la documentation de Gridsome/Tailwind existe déjà pour ça mais juste dire rapidement où est où
- tailwind.config.js
- gridsome.config.js
- gridsome.server.js
- types.graphql
- Ce fichier content les différents types GraphQL utilisés à travers le site
- src - https://gridsome.org/docs/directory-structure/
- assets
- layouts
- pages
- templates
- main.js
- content - dossier qui contient le contenu du site
En plus du guide pour contribuer au contenu du site, il faudrait une page qui explique les règles à suivre pour contribuer au côté technique du site et comment les appliquer.
Je pense pas qu'il y a besoin de montrer au gens comment configurer un éditeur de code (après tout, ils lisent un tutoriel sur comment contribuer au code) mais du moins expliquer que les outils suivants doivent être utilisés afin de respecter les conventions de style du répo:
Les deux sont disponible sous forme d'outil à utiliser directement (par-exemple
eslint .) ou comme extension à installer dans son éditeur de code (ESLint, Stylelint).Des plugins existent pour les deux pour la plupart des éditeurs, que ce soit les trucs modernes comme VS Code ou Atom ou les trucs avec moins de typing latency comme Emacs ou Vim.
Je recommande de faire installer en extension pour éditeur, ça fait un meilleur workflow avec de l'autofix on save, erreurs affichées en temps réel etc mais de quand même expliquer la possibilité d'installer et d'utiliser manuellement
Également, une troisième extension doit être installée obligatoirement :
Cette extension permet de configurer automatiquement l'éditeur de code par-rapport à des règles (par-exemple, utiliser 4 espaces pour l’indentation, utiliser un certain format de retour à la ligne etc) et donc d'éviter les erreurs "basiques" de style.
Quelques trucs à préciser :