Saltar al contenido ForoHackers

Revisión de código: por dónde empezar

Revisión de código
#3358 · · Citar · Denunciar

La revisión de código consiste en que otra persona distinta del autor lea un cambio antes de integrarlo. Detecta errores y problemas de diseño pronto, reparte el conocimiento del código y mantiene el estilo coherente. Bien hecha es una conversación sobre el código, nunca sobre la persona, y es una habilidad tanto de quien revisa como de quien escribe.

Conceptos clave

  • Cambios pequeños: una revisión de unos cientos de líneas recibe atención real; una enorme recibe un sello de goma.
  • Qué mirar: corrección, pruebas, diseño, nombres, seguridad y si el cambio hace lo que dice.
  • Automatizar el resto: formateadores, linters e integración continua se ocupan del estilo para que las personas piensen en el significado.
  • Tono: pregunta, explica el motivo, separa lo «obligatorio» de lo «menor» y elogia lo que está bien.
  • Deber del autor: describe el porqué, revisa tu propio diff primero y responde a los comentarios sin ponerte a la defensiva.

Vocabulario

  • Pull request: un cambio propuesto, con su discusión, antes de integrarse.
  • Nit: un comentario menor y opcional sobre estilo.
  • LGTM: «looks good to me», una aprobación.
  • Linter: una herramienta que señala código sospechoso o poco idiomático.

Qué estudiar, en orden

  1. Revisa tu propio diff línea a línea antes de pedírselo a nadie y anota lo que señalarías.
  2. Lee revisiones de un proyecto de código abierto bien llevado y fíjate en cómo se redactan.
  3. Escribe una lista de comprobación para tu lenguaje: manejo de errores, liberación de recursos, concurrencia, validación de entradas.
  4. Configura un formateador y un linter para que la lista se acorte.
  5. Practica revisar el diseño: ¿esto va aquí?, ¿lo entenderá la próxima persona?

Etiquetas relacionadas

#version-control #testing #open-source #secure-coding

No has iniciado sesión, así que esto se publica como anónimo: no se guarda con ello ninguna cuenta, nombre ni dirección, y no puede llevar enlaces ni imágenes. Inicia sesión o únete para publicar con tu nombre. Los registros de nuestro servidor web guardan la dirección y la hora de cada petición hasta 14 días; para que la tuya no quede en ellos, usa Tor. Para escribir al equipo de forma confidencial, usa el buzón. Firmar como fuente habitual (una clave guardada solo en este navegador)

Enviar tarda unos segundos aquí: tu navegador resuelve antes una prueba de trabajo contra el spam.

Responder