Code Review: când contextul salvează nervii (și reputația)

Google a publicat pe blogul său pentru testeri un articol care ar trebui să devină lectură obligatorie pentru oricine a scris vreodată „Adaugă teste” fără măcar un indiciu despre care anume. E vorba despre cum să adaugi context în răspunsurile la code review – și de ce contează.

De ce e dureros
Cu toții am văzut comentarii de genul „E prost” sau „Refă”. Autorul unui astfel de mesaj probabil se crede un guru, dar de fapt creează doar tensiune. Google propune o rețetă simplă: dacă critici codul, explică de ce. Și nu doar „pentru că așa zic eu”, ci cu referire la bune practici, bug-uri potențiale sau cerințe non-funcționale.

Când contextul e critic
Contextul e deosebit de important în trei situații: la discuții despre securitate (ca autorul să înțeleagă riscurile), la decizii arhitecturale complexe (ca să nu rescrii totul peste o lună) și la semnalarea bug-urilor (ca dezvoltatorul să poată reproduce problema). Și da, „pentru că mie nu-mi place” nu e context.

Cum să faci corect
În loc de „Scoate acest hack”, scrie: „Acest hack poate ceda la sarcini >1000 RPS, hai să folosim un cache cu TTL”. În loc de „Adaugă teste” – „Acoperă cazul cu răspuns gol de la API, am mai prins un bug ca ăsta în producție”. Și specifică ce ai verificat deja și ce e doar o ipoteză.

Comentariul echipei METABYTE
Și noi la METABYTE am trecut prin faza „LGTM” și „corectează după simțiri”. Acum avem în CI un plugin care evidențiază comentariile fără context – și numărul de teleconferințe nocturne a scăzut la jumătate. Vă recomandăm să încercați, chiar dacă code review-ul vostru e doar o bifă în Jira.