Revisão de código: como ser um bom escritor

Ei! Meu nome é Sergey Zagursky, trabalho na Joom na equipe de infraestrutura. Em minha prática como revisor de código, regularmente encontro o fato de que o autor não entende que o revisor não é uma caixa preta mágica na qual você pode jogar quaisquer alterações e obter feedback sobre elas. O revisor, assim como o autor, como ser humano, tem uma série de pontos fracos. E o autor deve (se, é claro, ele estiver interessado em uma revisão de qualidade), ajudar o revisor tanto quanto possível.





Quero dizer como o autor do código pode simplificar o trabalho do revisor e, assim, aumentar a qualidade da revisão e a produtividade do revisor. Este artigo pode muito bem ser usado em sua documentação corporativa interna como um guia para preparar alterações para revisão. Na verdade, foi compilado a partir desse guia.





Por que fazemos uma revisão 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