Aspectos básicos de la contribución para Microsoft Learn
Hay algunos términos para conocer que le ayudarán a comprender y completar el proceso de contribución. No es necesario saber todo lo que sucede, pero una visión general de cómo funciona la contribución le ayuda a comprender por qué el proceso funciona de la manera en que lo hace.
Aspectos básicos de Microsoft Learn y GitHub
Microsoft Learn contiene miles de artículos, módulos de entrenamiento, páginas web, etc., a los que varios colaboradores deben acceder periódicamente y almacenar. Microsoft Learn usa GitHub para almacenar gran parte de este contenido. GitHub es una plataforma que usa Git, un sistema de control de versiones distribuido, para almacenar proyectos y facilitar la colaboración entre varias partes interesadas con diferentes objetivos y líneas de tiempo del proyecto. El software de Git y GitHub le permite trabajar en paralelo con otros colaboradores en el mismo proyecto, potencialmente el mismo contenido, incluso al mismo tiempo, sin interferir involuntariamente con el trabajo de otros usuarios.
El contenido se almacena en archivos en repositorios de Git (repo) hospedados en GitHub. Un repositorio es una unidad de almacenamiento que contiene los archivos de un proyecto y el historial de revisiones de los archivos. Los repositorios pueden ser públicos o privados, y Microsoft Learn se compone de una combinación de ambos. Cualquier persona puede contribuir a un repositorio público una vez que haya configurado una cuenta de GitHub. Los repositorios privados solo están disponibles para los colaboradores que son empleados de Microsoft o a los que se les ha concedido permiso especial.
Realizar modificaciones en el contenido de Microsoft Learn almacenado en un repositorio de GitHub
Para cualquier proyecto, GitHub hospeda el repositorio principal y las bifurcaciones. Una bifurcación es una copia del repositorio principal que un colaborador realiza para su propio trabajo. Una bifurcación es una de las formas que tiene GitHub de proteger el contenido publicado. En lugar de editar directamente el contenido en la rama activa y publicada del repositorio principal, GitHub toma una instantánea de ese contenido para la bifurcación para que pueda realizar los cambios allí.
Los repositorios de GitHub contienen una o varias ramas. Una rama es una unidad de almacenamiento que contiene los archivos y carpetas que componen el conjunto de contenido de un proyecto. Todos los repositorios, ya sea el repositorio principal o una bifurcación, contienen una rama predeterminada (normalmente denominada "principal") y una o varias ramas destinadas a combinarse de nuevo en la rama predeterminada. La rama predeterminada sirve como la versión actual y la "única fuente de confianza" del proyecto. Se trata del elemento principal a partir del que se crean todas las demás ramas del repositorio.
La edición de un artículo de documentación en un repositorio público puede parecer que comienza con el toque de un botón, pero hay varias cosas que suceden en segundo plano. Al iniciar el proceso de edición basado en explorador, se crea una bifurcación del repositorio (si aún no tenía una) y se usa para los cambios. Usted edita dentro de una rama de la bifurcación, que más adelante se combinará con la rama activa del repositorio principal para que los cambios estén disponibles para todos.
Creación de una solicitud de incorporación de cambios
¿Cómo se produce esta combinación? Debe indicar a GitHub (en concreto, a los propietarios del repositorio principal y a los autores del artículo) que las modificaciones han finalizado y están listas para su revisión, publicación y que el mundo las vea. Para ello, cree y envíe una solicitud de cambios.
Una solicitud de cambios (PR) es una propuesta para que los cambios se combinen desde la rama de la bifurcación en la que estaba trabajando en la rama "principal" predeterminada del repositorio activo. Cuando trabaja en un repositorio público, los revisores humanos siempre revisarán las solicitudes de cambios antes de combinarlas. También puede haber algunas comprobaciones automatizadas, como la compatibilidad de combinación y la validación de compilación. Una vez completadas estas revisiones y resueltos los problemas, los cambios se combinarán en la rama activa y estarán disponibles en Microsoft Learn.
Flujo de trabajo para contribuciones menores a la documentación
En resumen, seguirá estos pasos generales al realizar pequeños cambios en la documentación de Microsoft mediante el editor web en GitHub:
- Al abrir un archivo en el explorador para editarlo, se crea automáticamente una bifurcación del repositorio público. También se crea una rama de la bifurcación, a menudo denominada rama de revisión.
- Realice los cambios en el archivo.
- Cree una solicitud de cambios para proponer que los cambios se revisen y combinen.
- La solicitud de cambios debe resolver cualquier problema y pasar todas las revisiones.
- La solicitud de cambios se combina con la rama principal del repositorio activo y los cambios se publican en Microsoft Learn.
A continuación, echemos un vistazo más detenidamente a cada paso para obtener información sobre cómo llevarlos a cabo.