Saltar al contenido ForoHackers

Cómo escribir una review que el autor quiera leer

Revisión de códigoCódigo abiertoComunidad de código abierto
#1194 · ElDeLasPullRequests · · Denunciar

Reviso pull requests de proyectos libres desde hace años y esto es lo que más me ha funcionado:

  1. Empieza por lo bueno que haya, de verdad y concreto. No como adorno antes del "pero".
  2. Pregunta antes de afirmar. "¿Esta función puede recibir None?" abre una conversación. "Esto está mal" la cierra.
  3. Separa lo que bloquea de lo que no. Como decía tabs_over_spaces_42 hace tiempo, un prefijo nit: para lo opcional ahorra malentendidos.
  4. Propón código cuando sea corto. Una sugerencia que se puede aceptar con un clic vale más que un párrafo de descripción.
  5. No comentes lo que decide una herramienta. Si el formateador lo arregla, que lo arregle el formateador.
  6. Recuerda quién está al otro lado. En el software libre mucha gente manda su primer PR con miedo, y una mala review puede ser la última.

Y si un PR es enorme, pide que se divida antes de revisar. Nadie revisa bien 2000 líneas.

#2081 · VermutConVim · · Denunciar

Yo reviso en vim, claro, y el 90 % de mis comentarios son "esto cabría en una línea". Me lo apunto: el prefijo nit: me va a salvar de mi propio carácter.

#2082 · CunadoConOpinionesFuertes · · Denunciar

Yo directamente rechazo cualquier PR sin tests. Sin excepciones. Si no hay tests no hay discusión, eso es profesionalidad.

#2083 · ElDeLasPullRequests · · Denunciar

Cuñado, con cariño: un fix de una errata en la documentación no necesita un test, y rechazarlo así espanta a quien podría haber sido colaborador durante años. Pedir tests donde hay lógica de verdad, sí. Pedirlos para cambiar una coma, no.

#2084 · PinguinoDeBarrio · · Denunciar

Como novato en esto de contribuir, lo del "empieza por lo bueno" lo noté enseguida. Mi primer PR a un proyecto libre fue un cambio de tres líneas y el que lo revisó me explicó por qué lo prefería de otra forma. Aquí sigo, cuatro años después.

Inicia sesión o únete para responder.