La documentación de GitHub es de código abierto. Cualquier usuario puede contribuir a los documentos en el repositorio docs público: https://github.com/github/docs. Los empleados de GitHub trabajan en la documentación en una copia de este repositorio denominado docs-internal. Los dos repositorios se sincronizan automáticamente para mantener ambos actualizados con los cambios combinados en la rama main de cualquiera de los repositorios. Para simplificar, nos referiremos a "el repositorio de documentación" en los artículos sobre cómo contribuir a GitHub Docs.
El repositorio de documentación es el lugar para discutir y colaborar en la documentación que se publica aquí en docs.github.com.
Issues
Las incidencias se usan para realizar un seguimiento de las tareas con las que pueden ayudar los colaboradores. Si una incidencia tiene una etiqueta triage, aún no la hemos revisado y no debería empezar a trabajar en ella.
Si has encontrado algo en el contenido de la documentación, o bien algo sobre el sitio web docs.github.com, que debe actualizarse, busca las incidencias abiertas para ver si otro usuario ha notificado lo mismo. Si es algo nuevo, abre una incidencia mediante una plantilla. Usaremos la incidencia para tener una conversación sobre el problema que deseas que se corrija.
Note
Los empleados de GitHub deben abrir las propuestas en el repositorio docs-content privado.
Solicitudes de incorporación de cambios
Una PR es una manera de sugerir cambios en nuestro repositorio. Cuando combinamos esos cambios, se implementan en el sitio activo en 24 horas.
No podemos aceptar contribuciones a la documentación de referencia de API REST. Si detectas una imprecisión en la documentación de referencia de API REST, abre una incidencia en el repositorio rest-api-description.
Solo documentamos productos, características, herramientas y extensiones de GitHub. Podemos mencionar o vincular a herramientas de terceros para demostrar cómo funciona una característica, pero no aceptamos solicitudes de incorporación de cambios para documentar herramientas o integraciones de terceros a menos que se hayan desarrollado conjuntamente con GitHub.
Revisión de tus propias PR
Siempre debes revisar primero tu propia PR, antes de marcarla como lista para revisión por parte de otros usuarios.
Para los cambios de contenido, asegúrate de:
- Confirmar que los cambios cumplen la experiencia del usuario y los objetivos descritos en el plan de diseño de contenido (si existe).
- Revisar el contenido para mejorar la precisión técnica.
- Comprueba los cambios en cuanto a gramática, ortografía y adhesión a Guía de estilo.
- Asegúrate de que el texto de tu PR sea fácil de traducir. Para obtener más información, vea «Escritura de contenido que se va a traducir».
- Comprueba las instrucciones Liquid nuevas o actualizadas para confirmar que el control de versiones es correcto. Para obtener más información, vea «Documentación sobre el control de versiones».
- Comprueba la versión preliminar de las páginas que has cambiado. Una versión preliminar se genera automáticamente después de enviar una PR y se agregan vínculos a la PR. La versión preliminar a veces tarda varios minutos en poder verse. Confirma que todo se representa según lo previsto. Comprobar la versión preliminar te ayudará a identificar problemas como errores tipográficos, contenido que no sigue la guía de estilo o contenido que no se representa debido a problemas de control de versiones. Asegúrate de comprobar la salida representada en busca de listas y tablas, que a veces pueden tener problemas difíciles de identificar en Markdown.
- Si hay comprobaciones con errores en la PR, soluciónalos hasta que todas se superen.
Soporte técnico
Somos un equipo pequeño que trabaja duro para mantenerse al día con las demandas de documentación de un producto que cambia continuamente. Lamentablemente, no podemos ayudar con preguntas de soporte técnico en este repositorio. Si tienes un problema con GitHub, no relacionado con nuestra documentación, ponte en contacto con el soporte técnico de GitHub directamente. Cualquier problema o solicitud de cambios abierta en el repositorio de documentación que solicita soporte técnico recibirá información sobre cómo ponerse en contacto con el soporte técnico de GitHub, cerrándose y bloqueándose posteriormente.
Si tienes problemas con la cuenta de GitHub, ponte en contacto con el soporte técnico.
Translations
Este sitio web está internacionalizado y disponible en varios idiomas. El contenido de origen de este repositorio está escrito en inglés. Automatizamos las traducciones a través de un proceso interno, trabajando con traductores profesionales para localizar el contenido en inglés.
Si detectas un error de traducción, registra una incidencia con los detalles.
Actualmente no aceptamos PR para el contenido traducido.
Directiva del Sitio
Las directivas del sitio de GitHub también se publican en docs.github.com.
Si encuentras un error tipográfico en la sección de la directiva del sitio, puedes abrir una PR para corregirlo. Para cualquier otra cosa, consulta "Contribución" en el repositorio site-policy.