Contributions à la documentation
Le site de documentation de Playground est maintenu par des bénévoles comme vous, qui apprécieraient votre aide.
Toutes les issues liées à la documentation sont étiquetées [Type] Documentation ou [Type] Developer Documentation dans le dépôt WordPress/wordpress-playground. Parcourez la liste des issues ouvertes pour en trouver une sur laquelle vous aimeriez travailler. Alternativement, si vous pensez qu'il manque quelque chose à la documentation actuelle, ouvrez une issue pour discuter de votre suggestion.
Comment puis-je contribuer ?
Vous pouvez contribuer en ouvrant une issue dans le dépôt du projet et en décrivant ce que vous aimeriez ajouter ou modifier.
Si vous vous sentez prêt·e à le faire, écrivez le contenu dans la description de l’issue, et les contributeurs ou contributrices du projet s’occuperont du reste.
Vous souhaitez voir la documentation dans votre langue ? Consultez la section Traductions.
Forker le dépôt, modifier des fichiers localement et ouvrir des Pull Requests
Si vous êtes familier ou familière avec markdown, vous pouvez forker le dépôt wordpress-playground et proposer des changements et de nouvelles pages de documentation en soumettant une pull request (demande de tirage).
Le processus de création d'une branche pour ouvrir de nouvelles PR avec les pages traduites dans le dépôt WordPress/wordpress-playground est le même que pour contribuer à d'autres dépôt WordPress comme celui de Gutenberg : https://developer.wordpress.org/block-editor/contributors/code/git-workflow/
Les fichiers de documentation (fichiers .md) sont stockés dans le dépôt GitHub de Playground, sous /packages/docs/site/docs pour l'anglais et /packages/docs/site/i18n pour les autres langues.
Modifier dans le navigateur
Si vous êtes connecté·e à GitHub, vous pouvez également modifier des fichiers existants (ou en ajouter de nouveaux) et soumettre un PR directement depuis l'interface utilisateur GitHub :
- Recherchez la page que vous souhaitez modifier ou le répertoire du chapitre auquel vous souhaitez ajouter une nouvelle page.
- Cliquez sur le bouton Ajouter des fichiers pour ajouter un nouveau fichier, ou cliquez sur un fichier existant puis sur l'icône du crayon pour le modifier.
- GitHub vous demandera de forker le dépôt et de créer une nouvelle branche avec vos modifications.
- Un éditeur s’ouvre pour vous permettre d'y effectuer les modifications.
- Lorsque vous avez terminé, cliquez sur le bouton Commit Changes et soumettez une Pull Request.
Voilà, c’est fait ! Vous venez de contribuer à la documentation de WordPress Playground.
Cette approche signifie que vous n’avez pas besoin de cloner le dépôt, de mettre en place un environnement de développement local ou d’exécuter des commandes.
L’inconvénient, c’est que vous ne pourrez pas prévisualiser vos modifications. Continuez à lire pour savoir comment réviser vos modifications avant de soumettre une Pull Request.
Prévisualisation en local
Cloner le dépôt et naviguer vers le répertoire de votre machine. Lancer à présent les commandes suivantes :
npm install
npm run build:docs
npm run dev:docs
Le site de documentation s’ouvre dans un nouvel onglet du navigateur et s’actualise automatiquement à chaque modification. Continuez à modifier le fichier concerné dans votre éditeur de code et testez les changements en temps réel.