Proceso de revisión del código

Objetivos

Nuestro proceso de revisión tiene varios objetivos:

  • Garantiza un código de alta calidad, tanto en funcionalidad como en legibilidad.
  • Detecta errores, porque se producen.
  • Mantén un estilo coherente para que sea fácil comenzar a trabajar en cualquier parte de la base de código.

Se revisa todo el código que se encuentra en blockly-samples y core Blockly, ya sea escrito por colaboradores de la comunidad o miembros del equipo de Blockly.

Como revisores, queremos trabajar contigo para que los cambios sean lo más buenos posible. Te pedimos que, como colaboradores, participes en una conversación con nosotros para revisar y combinar tus solicitudes de extracción.

El proceso

El proceso de revisión de RR.PP. abarca algunas etapas:

  1. Tarea
  2. Comentarios
  3. Debate
  4. Revisión
  5. Repeticiones
  6. ¡Combina!

Assignment

Cuando llega tu solicitud de extracción, el miembro de guardia del equipo de Blockly asigna un revisor.

Los revisores se eligen en función de sus conocimientos y distribuyen la carga de trabajo de manera uniforme.

Es posible que transcurran algunos días antes de que se asigne un revisor y otros días más antes de que se obtenga una revisión. No te preocupes, es normal.

Comentarios

Durante la etapa de retroalimentación, un revisor deja sugerencias para los cambios en tu RR.PP. Pueden ser elementos simples para que tu código se ajuste a la Guía de estilo de Google JavaScript. O pueden ser elementos más grandes, como pedirte que reorganices las definiciones de las funciones.

Se recomienda a los revisores que usen las revisiones de código de GitHub (en lugar de hacer comentarios individuales) para que recibas una sola notificación en lugar de varias.

Discusión

La fase de debate es tu oportunidad de responder al feedback. Tal vez uno de los comentarios de la opinión no fue claro: ahora es tu oportunidad de pedir aclaraciones. O quizás el revisor solicitó un cambio, pero crees que tendrá repercusiones: esta es tu oportunidad de llegar a un acuerdo.

Revisión

En la fase de revisión, puedes realizar cambios en tu RP. Por lo general, estos cambios son el resultado de algo que el revisor dijo en la fase de comentarios.

Una vez que hayas completado las revisiones, puede ser útil etiquetar al revisor y pedirle que vuelva a revisarlo.

Repetición

Después de la fase de revisión, el revisor tendrá otra oportunidad para enviar comentarios, y el proceso comenzará desde el principio.

Por lo general, una segunda revisión es simple y se centra en nits, como la puntuación y el estilo de código. Pero, a veces, una segunda opinión puede ser bastante grande. Tu primer revisor incluso puede pedirle a otra persona que lo revise para obtener una nueva perspectiva.

Combinar

La fase de fusión es tu oportunidad para celebrar. Creaste un cambio, lo analizaste y revisaste, ¡y finalmente lo fusionaste! ¡Este es un gran logro que muchas personas nunca comienzan, mucho menos lo completan!

Gracias por esforzarte para mejorar Blockly. ¡Felicitaciones!