Pull Requesti koodiülevaatus GitHubis

Harjutad koodi ülevaatamist ülevaataja rollis. Kontrollid vahekaardil Files changed, kas kood vastab nõuetele, jätad ridadele selged ja viisakad kommentaarid ning palud vajadusel parandusi. Pärast autori uut commiti vaatad koodi uuesti üle ja kinnitad Pull Requesti.

Tootest

Kadri, mentor

Tere! Eelmisel korral vaadati üle sinu Pull Request. Täna vahetame rollid: ülevaataja oled sina. Arendusmeeskonna Marko avas PR-i tellimuse allahindlusega ja see tuleb üle vaadata. Aga kõigepealt neli lihtsat reeglit kommentaaride kohta.

Lühiviide

Files changed

PR-i vahekaart, kus on näha, millised failid ja read muutusid: rohelised read märgiga + on lisatud, punased märgiga − eemaldatud. Ülevaatust alustatakse siit.

Mida kontrollida

Kas kood vastab ülesande nõuetele (eriti piirväärtused), selgus ja loetavus: nimed, silumisväljundi ja üleliigse koodi puudumine.

Kommentaar reale

Vii kursor reale — ilmub sinine „+“. Vajuta seda, kirjuta kommentaar ja vajuta Add single comment. Nii saab kommenteerida kui tahes palju ridu.

Review changes

Ülevaatuse tulemus: üldine kommentaar ja otsus. Comment on tagasiside, mis ei kinnita ega blokeeri, Approve tähendab, et võib liita, Request changes — enne liitmist tuleb parandada. Saadetakse nupuga Submit review.

Kommentaaride toon

Kommentaar räägib koodist, mitte autorist. Ütle, mis on valesti, selgita miks ja paku parandus. Viisakus ja konkreetsus säästavad mõlema aega.

Pärast Request changes

Autor parandab koodi eraldi commitiga samasse harusse ja teeb pushi — PR uueneb ise. Ülevaataja kontrollib muudatused uuesti ja kinnitab, misjärel saab PR-i liita (Merge).