Review kode: bagaimana menjadi penulis yang baik

Hei! Nama saya Sergey Zagursky, saya bekerja di Joom di tim infrastruktur. Dalam praktik saya sebagai peninjau kode, saya secara teratur menemukan fakta bahwa penulis tidak memahami bahwa peninjau bukanlah kotak hitam ajaib tempat Anda dapat melakukan perubahan apa pun dan mendapatkan umpan balik tentangnya. Pengulas, seperti penulis, sebagai manusia, memiliki sejumlah kelemahan. Dan penulis harus (jika, tentu saja, tertarik dengan ulasan yang berkualitas), membantu pengulas sebanyak mungkin.





Saya ingin memberi tahu Anda bagaimana penulis kode dapat menyederhanakan pekerjaan pengulas dan dengan demikian meningkatkan kualitas ulasan dan produktivitas pengulas. Artikel ini mungkin dapat digunakan dalam dokumentasi internal perusahaan Anda sebagai panduan untuk menyiapkan perubahan untuk ditinjau. Sebenarnya, itu disusun dari panduan semacam itu.





Mengapa kami melakukan peninjauan kode

. , .





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





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





, . , . , , 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