GitHubla documentación es código abierto. Cualquier persona puede contribuir a los documentos del repositorio público docs : https://github.com/github/docs. GitHub los empleados 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 integrados en la rama main de cualquiera de estos. 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.
Problemas
Las cuestiones se utilizan para realizar un seguimiento de las tareas en las que los colaboradores pueden ayudar. 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.
Nota:
GitHub los empleados deben abrir problemas en el repositorio privado docs-content .
Solicitudes de incorporación de cambios
Una solicitud de extracción es una forma 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 GitHub productos, características, herramientas y extensiones. 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 pull request sea fácil de traducir. Para más información, consulta Redacción de contenido para traducir.
- Comprueba las declaraciones Liquid nuevas o actualizadas para confirmar que la gestión de versiones es correcta. Para más información, consulta Documentación sobre el control de versiones.
- Comprueba la versión preliminar de las páginas que has cambiado. Una vista previa se genera automáticamente después de enviar una solicitud de extracción, y se agregan enlaces a la solicitud de extracción. La versión preliminar a veces tarda varios minutos en poder verse. Confirma que todo se muestra como se esperaba. 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 tiene un problema con GitHub, no relacionado con nuestra documentación, póngase en contacto con el GitHub soporte técnico directamente. Los problemas o solicitudes de incorporación de cambios abiertos en el repositorio de documentación que solicitan soporte técnico se proporcionarán información sobre cómo ponerse en contacto con GitHub el soporte técnico y, a continuación, cerrar y bloquear.
Si tiene problemas con su GitHub cuenta, póngase en contacto con el soporte técnico.
Traducciones
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 solicitudes de incorporación de cambios para el contenido traducido.
Directiva del Sitio
GitHubLas directivas de sitio 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.