Los 10 mandamientos de la revisión de código

Para quien propone el cambio

  1. Haz peticiones de cambios unitarias. 🔢 Tu merge request debe introducir un solo cambio, de tamaño razonable.
  2. Describe qué hace tu código desde un punto de vista general. ✏️ Da suficiente contexto a quien revisa para que entienda qué intentas conseguir.
  3. Responde a todos los comentarios. ✅ Todos los comentarios tienen su importancia; no dejes ninguno sin respuesta.
  4. No te lo tomes personalmente. ❤️ Es siempre un bien para el equipo que las ideas se confronten.

Para quien revisa

  1. Revisa el código todos los días. ⏰ La revisión de código es buena para la comunicación y para compartir conocimiento.
  2. Lee la descripción del merge request antes de saltar al código. 📖 Primero entiende qué intenta cambiar el autor; después comprueba si el cambio está bien implementado.
  3. Sé preciso y usa frases completas. 🔊 El autor no debería tener que adivinar qué quieres decir. Al hacer comentarios, recuerda que nada es obvio para tu interlocutor.
  4. Sé amable. 👼 «Esta variable debe renombrarse a userId» frente a «¿Qué te parece renombrar esta variable para que sea coherente con las demás?»
  5. Usa la regla OIS. 📏 Observa-Impacto-Sugiere. Observa: «este método tiene 100 líneas». Impacto: «me resulta complicado entender su lógica». Sugiere: «puedes extraerlo en 2 métodos con nombres explícitos».