Ejercicio: Creación de la primera solicitud de incorporación de cambios

  • 6 minutos

Ha aprendido a crear una solicitud de incorporación de cambios (PR) cuando hay instrucciones, ya sea en una plantilla de solicitud de incorporación de cambios o en un archivo CONTRIBUTING. ¿Pero qué ocurre si un proyecto no ofrece esas instrucciones ni documentación sobre las convenciones?

Descripción de los cambios

Para escribir un buen mensaje de confirmación y, posteriormente, la solicitud de incorporación de cambios, siga estos procedimientos:

  • La línea de asunto del mensaje de confirmación de Git debe completar la frase siguiente:
    • Si se aplica, esta confirmación será <your subject line here>.
  • Incluya una descripción concisa del cambio en presente de imperativo. Por ejemplo, utilice add no added o adds.
  • Limite la línea de asunto a 50 caracteres.
  • Comience con mayúscula y no termine con punto (.).
  • Puede usar emojis u @mention otros usuarios de GitHub en la línea de asunto, pero tenga en cuenta que no todos los proyectos permiten o fomentan esto.

Para el cuerpo del mensaje y la solicitud de incorporación de cambios, siga usando el presente. Asegúrese de incluir la motivación del cambio. Compare el cambio con el comportamiento anterior. Use el espacio a su disposición para explicar qué y por quéy cómo.

El mensaje de confirmación debe ser tan preciso como el contenido que está a punto de enviar. Para la confirmación o la revisión, utilice conjuntos de cambios pequeños y aislados. Esta práctica aumenta la probabilidad de que los cambios se combinen en el proyecto.

Adición de granularidad

Antes de enviar la solicitud de incorporación de cambios, consulte la barra lateral para obtener formas de completarla. Seleccione Revisores o Asignadores si está familiarizado con la estructura del equipo del proyecto. Agregue etiquetas cuando haya instrucciones sobre el uso de etiquetas en, por ejemplo, el archivo CONTRIBUTING.md. Puede usar las etiquetas como una pista visual de lo que intenta conseguir. Es posible que un mantenedor también agregue una etiqueta o varias etiquetas.

Sugerencia

Si el repositorio tiene un archivo CONTRIBUTING.md o una plantilla de solicitud de cambios, siga sus instrucciones al rellenar la solicitud de cambios.

Algunas de las etiquetas que se usan en el repositorio para este módulo de Learn son las siguientes:

  • Error (rojo): algo no funciona
  • Documentación (azul): mejoras o adiciones a la documentación
  • Duplicado (gris): este problema o solicitud de incorporación de cambios ya existe
  • Mejora (teal): nueva característica o solicitud

También puede vincular incidencias en la barra lateral, donde la combinación correcta de una solicitud de incorporación de cambios puede cerrar la incidencia correspondiente. También puede personalizar la suscripción a las notificaciones en el hilo. Algunas PR reciben muchos comentarios, revisiones y notificaciones relacionadas con CI/CD. Puede elegir entre:

  • No suscrito: Solo recibir notificaciones cuando haya participado o que estuviera @mentioned
  • Subscrito: Recibir todas las notificaciones de esta solicitud de incorporación de cambios
  • Personalizado: Solo recibirás notificaciones para los eventos que selecciones

Ejercicio

Usando el proyecto First Contributions, practique crear un fork, clonar y realizar un pull request. El proyecto First Contributions tiene como finalidad "guiar a los principiantes mientras realizan su primera contribución". Contiene guías para usar la línea de comandos y varias interfaces gráficas de usuario (GUI). El proyecto también admite varios idiomas. Asegúrese de comprobar la carpeta Translations.

Con las lecciones de la unidad anterior y esta presentes, vuelva a una solicitud de incorporación de cambios que haya abierto recientemente. O bien, puede ir a la pestaña de solicitudes de incorporación de cambios de un proyecto que esté viendo. Observe cómo una buena línea de asunto puede marcar la diferencia. Considere la posibilidad de actualizar una solicitud de incorporación de cambios en consecuencia. Dedique aproximadamente el mismo tiempo a escribir la solicitud de incorporación de cambios que dedicó a realizar el cambio en el proyecto. Sus esfuerzos ayudarán a los mantenedores a establecer categorías y clasificar por orden de prioridad (evaluación de prioridades) las contribuciones de la comunidad.

Sobresueldo: Compruebe las directrices y los requisitos de accesibilidad de Microsoft. En concreto, consulte la información sobre cómo describir las interacciones con la interfaz de usuario para evitar el lenguaje ableist en sus contribuciones. Los clientes interactúan con los productos mediante distintos métodos de entrada. Por ejemplo, pueden usar el teclado, un mouse, toques, voz, etc. Es conveniente usar verbos genéricos que funcionen con cualquier método de entrada. Por ejemplo, use select en lugar de los métodos de entrada específicos como clic o deslizar el dedo.