Revisión de código: cómo ser un buen escritor

¡Oye! Mi nombre es Sergey Zagursky, trabajo en Joom en el equipo de infraestructura. En mi práctica como revisor de código, me encuentro con regularidad con el hecho de que el autor no comprende que el revisor no es una caja negra mágica en la que se pueden introducir cambios y obtener comentarios sobre ellos. El revisor, como el autor, como ser humano, tiene una serie de debilidades. Y el autor debería (si, por supuesto, está interesado en una revisión de calidad), ayudar al revisor tanto como sea posible.





Quiero decirles cómo el autor del código puede simplificar el trabajo del revisor y, por lo tanto, aumentar tanto la calidad de la revisión como la productividad del revisor. Este artículo se puede utilizar en su documentación corporativa interna como una guía para preparar los cambios para su revisión. De hecho, se compiló a partir de dicha guía.





¿Por qué hacemos una revisión de código?

. , .





. , . , . . . , « », . , . 





: . — . , , . . , . , , . 





, . , . , , write only . .





, . - ( ). , .





— .





, , , . , . . , , « ». , , . . , . - .





, . . , . , . , . .





- , , . , , , , . , , , , , .





, -, . , , , .





. , , -, , . . .





, , , , . Pull Request .





, , , . , , .





, Pull Request, , . 500 . — 1000 . , 1000 , Pull Request’. 





, , , . , , . 1000+ , , , . . , . , Pull Request’, « ».





, sed’. . . Pull Request’, , .





. , : , , , . . — . , , . 





- , , . . , « » - . . , , , , .





, , . , , . , .





, . ? ! , . , . . . . - , , TODO-, , . , . . 





, 10% , , . , , . , 20%, 50% , .





.





Pull Request’. , . , . «OK» «», . , , . , . — . - , , . , , , . , , . , , , .





Pull Request, , . . rebase .





? , !








All Articles