Bagian pertama dari artikel ini menyoroti aspek standar ulasan kode dan poin yang perlu ditangani terlebih dahulu. Pada bagian terakhir, mari kita bicara tentang:
- prosedur peninjauan
- kecepatan (dan apa pengaruhnya)
- cara menulis komentar,
- diskusi selama peninjauan.
1. Navigasi melalui daftar perubahan dalam ulasan
TL; DR
Sekarang setelah Anda memahami apa yang perlu Anda perhatikan , Anda perlu memutuskan apa urutan ulasannya. Ada 3 tahapan utama:
- Memahami apakah fungsionalitas yang disajikan diperlukan pada prinsipnya dan apakah memiliki deskripsi yang baik ;
- Memperhatikan hal terpenting dalam kode yang dimodifikasi dan seberapa baik solusinya dirancang secara keseluruhan;
- Lihat perubahan yang tersisa dalam urutan yang Anda inginkan.
1.1. Ubah Ikhtisar
Lihatlah deskripsi CL dan fungsi utamanya: apakah perubahan ini diperlukan? Jika fungsionalitas yang diusulkan tidak diperlukan, coba laporkan sesegera mungkin dan jelaskan alasannya. Dalam hal ini, disarankan untuk menawarkan tugas kepada pengembang sebagai imbalan.
: " , , , FooWidget, . . , BarWidget . ?"
, : CL . : , .
, , , — , . "" , , .
1.2.
CL — , . — . CL , , CL .
CL, , CL . , , — .
:
1.3.
CL , . . , . — .
2.
2.1. - ?
Google , , , . , .
, - :
- . , , , . , , , , .
- . , . . , , , CL , . , .
- . , . , CL.
2.2. ?
- , , .
— ( , , ).
, CL ( ) .
2.3. vs
, : - , , , . , , . , , , .
: , , , .
2.4.
-, , , , , CL . , .
, , .
, , , CL , . . , — .
, , . , , .
2.5.
, , , , . , .
2.6. LGTM (looks good to me = )
, , CL . :
LGTM , "LGTM, Approval".
2.6. CL
CL , CL CL, . , .
CL , , CL, , . , , .
2.7. -
, , . , CL . . , , — , .
2.8.
, CL . . , , " ".
3.
TL;DR
3.1.
, , , , . — , . , , , -, . :
: " , ?"
: " , , . , , ."
3.2.
"" , . , — , .
3.3.
CL, . .
. , , . , , , , , , , , .
, . , CL , — , .
3.4.
, , , . , , , , .
, , . : , , , , , .
4.
, .
4.1. ?
, — , . , . ? ? , .
, . , . , - .
, , , . .
, . , . , .
4.2. ?
, , . , , , , , . , , , . , , .
4.3. " "
( ) , . , - CL, . CL . , , CL, - . , . , — , , , "". .
CL , CL , . CL , , , , TODO- .
4.4.
, , . .
, , , .
Bahkan lawan yang paling bersemangat dari ulasan ketat dapat menjadi sekutu terbesar Anda ketika dalam praktiknya mereka menghadapi situasi yang membuktikan bahwa posisi sulit Anda dalam ulasan itu benar.
4.5. Resolusi konflik
Jika Anda mengikuti semua aturan di atas, tetapi masih ada konflik dengan pengembang dan Anda tidak bisa menyelesaikannya, lihat Standar Peninjauan Kode untuk memahami praktik dan standar yang dapat membantu Anda menyelesaikan konflik.