Contribuciones a la documentación
El sitio de documentación de WordPress Playground lo mantienen voluntarios como tú, que agradecerían tu ayuda.
Todas las cuestiones relacionadas con la documentación se etiquetan como [Type] Documentation o [Type] Developer Documentation en el repositorio WordPress/wordpress-playground. Explora la lista de incidencias abiertas para encontrar una en la que te gustaría trabajar. Alternativamente, si crees que falta algo en la documentación actual, abre una incidencia para discutir tu sugerencia.
¿Cómo puedo contribuir?
Puedes contribuir abriendo una incidencia en el repositorio del proyecto y describiendo lo que te gustaría añadir o cambiar.
Si te animas, escribe el contenido en la descripción de la incidencia y los contribuidores del proyecto se encargarán del resto.
¿Te gustaría ver la documentación en tu idioma? Consulta la sección de traducciones.
Bifurcar el repositorio, editar archivos localmente y abrir pull requests
Si estás familiarizado con markdown, puedes bifurcar el repositorio wordpress-playground y proponer cambios y nuevas páginas de documentación enviando un pull request.
El proceso de crear una rama para abrir nuevos PRs con páginas traducidas en el repositorio WordPress/wordpress-playground es el mismo que para contribuir a otros repositorios de WordPress como gutenberg: https://developer.wordpress.org/block-editor/contributors/code/git-workflow/
Los archivos de documentación (archivos .md) se almacenan en el repositorio de GitHub de Playground, en /packages/docs/site/docs para inglés y en /packages/docs/site/i18n para otros idiomas.
Editar en el navegador
Si has iniciado sesión en GitHub, también puedes editar archivos existentes (o añadir otros nuevos) y enviar un PR directamente desde la interfaz de usuario de GitHub:
- Busca la página que te gustaría editar o el directorio del capítulo al que te gustaría añadir una nueva página.
- Haz clic en el botón Añadir archivos para añadir un nuevo archivo, o haz clic en un archivo existente y luego en el icono del lápiz para editarlo.
- GitHub te pedirá que bifurques el repositorio y crees una nueva rama con tus cambios.
- Se abrirá un editor en el que podrás hacer los cambios.
- Cuando hayas terminado, haz clic en el botón Confirmar cambios y envía un pull request.
¡Eso es todo! Acabas de contribuir a la documentación de WordPress Playground.
Este enfoque significa que no necesitas clonar el repositorio, configurar un entorno de desarrollo local ni ejecutar ningún comando.
La desventaja es que no podrás previsualizar tus cambios. Sigue leyendo para aprender cómo revisar tus cambios antes de enviar un pull request.
Vista previa local
Clona el repositorio y navega hasta el directorio en tu dispositivo. Ahora ejecuta los siguientes comandos:
npm install
npm run build:docs
npm run dev:docs
El sitio de documentación se abre en una nueva pestaña del navegador y se actualiza automáticamente con cada cambio. Continúa editando el archivo correspondiente en tu editor de código y prueba los cambios en tiempo real.