Un comentario de revisión debería ayudar al autor a comprender qué necesita atención y por qué. Señale un comportamiento, riesgo o preocupación de mantenimiento específicos en lugar de dejar una reacción vaga en una línea de código.
Hacer visible el razonamiento
- Describa el escenario donde el código actual podría fallar o confundir a un futuro mantenedor.
- Separe un cambio de corrección o seguridad requerido de una sugerencia de estilo opcional.
- Haga una pregunta cuando le falte contexto en lugar de asumir la intención del autor.
Ofrecer un camino a seguir
Cuando sea útil, sugiera una alternativa o una prueba que resuelva el problema. Mantener el cambio solicitado proporcional a su impacto; No haga de su preferencia personal un bloqueador de liberación.
Revise el cambio completo, no solo la decoración diferencial. Si un tema es lo suficientemente importante como para impedir la fusión, resúmalo claramente para que el autor pueda encontrar el trabajo restante.