Cómo escribir una buena solicitud de extracción

Las solicitudes de extracción son como la sangre vital de un repositorio. Mantienen todo en buen estado y en movimiento. En esta página, se detalla cómo crear una PR que sea completa y fácil de revisar, lo que aumenta las probabilidades de que se combine.

Estos son algunos pasos que puedes seguir para asegurarte de crear la mejor RP posible.

  1. Cómo comunicarte
  2. Iniciar configuración
  3. Manténlo pequeño
  4. Mantén la limpieza
  5. Cómo probar tu cambio
  6. Comunicarse (2ª parte)

Comunícate

Antes de comenzar a escribir código, es útil comunicarse con el equipo principal para que sepan qué te interesa.

Si hay un problema que te interesa, haz un comentario en el que digas que vas a comenzar a trabajar en él. Esto garantiza que no haya varias personas trabajando en lo mismo. Un miembro del equipo responderá para confirmar que es tuyo.

Si tienes una idea que no se incluye en un problema, escríbela antes de comenzar a trabajar. Esto le brinda al equipo la oportunidad de analizar la mejor manera de implementar el cambio antes de que comiences a compilar, lo que te ahorrará trabajo a largo plazo.

Prepárate

Si es la primera vez que contribuyes a Blockly o blockly-samples, comienza en la página de configuración de desarrollo.

Mantén el tamaño pequeño

Intenta que los cambios sean pequeños y estén enfocados. Preferimos revisar varios PR más pequeños que revisar uno gigante. Estas son algunas reglas generales:

  • Soluciona un problema. No intentes abordar varios problemas a la vez.
  • Limita el alcance. Por lo general, una PR debería tardar menos de 8 horas (según tu nivel de conocimiento de la base de código).
  • Usa confirmaciones. Si tu PR parece un poco grande, divide los cambios en grupos lógicos con confirmaciones de git.

Mantén la limpieza

¿Por qué es importante el estilo de código? Estamos aquí a largo plazo, y un estilo coherente facilita el mantenimiento. El estilo se refiere a cómo nombras tus variables, pero también abarca cómo estructurar tu código, escribir comentarios y mucho más. Siempre que sea posible, usamos herramientas como eslint para automatizar las verificaciones de estilo.

Además de eslint, sigue estas guías:

Prueba el cambio

Antes de publicar una PR, siempre debes probar que los cambios funcionen, de modo que no tengas que volver y corregirlos más adelante. Estas son algunas ideas para probar las diferentes categorías de proyectos:

  • Para los complementos, escribe pruebas automatizadas de Mocha que incluyan tus cambios.
  • Para ver ejemplos, prueba manualmente todas las funciones que demostraste.
  • Para los codelabs, completa todo el instructivo en un entorno limpio y prueba cualquier código de ejemplo que proporciones.

Comunícate

Esta es la última parte y, posiblemente, la más importante de la creación de una PR: escribir el resumen.

Escribir un excelente resumen de relaciones públicas ayuda a que otros desarrolladores revisen tus cambios, lo que aumenta la probabilidad de que se acepten más rápido.

Tu resumen debe incluir lo siguiente:

  • El problema con el que se relaciona tu PR.
  • Qué cambio agrega tu PR.
  • Cómo probaste el cambio.
  • Cualquier elemento que quieras que los revisores analicen.
  • Cualquier otra información que creas que los revisores necesitan

Si sigues la plantilla de PR cuando creas tu solicitud, deberías estar bien. Solo recuerda ser lo más concisa y completa posible.

¡Diviértete programando!