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
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.
Tere, Kadri! Mis on esimene reegel?
1. Viisakalt. Kommentaar räägib koodist, mitte autorist. Kirjuta nii, nagu tahaksid ise tagasisidet saada.
✗ HalvastiJälle viga. Kas sa üldse lugesid ülesannet?
✓ HästiTundub, et siin pole nõue täidetud — vaata palun üle.
Ja teine?
2. Asjakohaselt. Kommentaar on konkreetse rea juures ja ütleb täpselt, mis on valesti. Üks probleem — üks kommentaar.
✗ HalvastiSiin on midagi valesti.
✓ HästiTäpselt 100-eurose tellimuse korral on allahindlus 5 %, mitte 10 %.
Kas sellest piisab?
3. Üksikasjadega. Selgita, miks: milline nõue on rikutud ja millisel väärtusel see katki läheb. Autor ei pea arvama.
✗ HalvastiVale tingimus.
✓ HästiNõude järgi 10 % „alates 100 €“. Kui total = 100, on tingimus total > 100 väär.
Ja viimane?
4. Konstruktiivselt. Paku lahendus või esita küsimus. Ja too välja, mis on hästi tehtud: ülevaatus aitab autorit, mitte ei hinda teda.
✗ HalvastiTee ümber.
✓ HästiSoovitan total >= 100. Muus osas on loogika selge, aitäh!
Jätan meelde! Kuidas ülevaatus ise käib?
Ülevaataja loeb muudatused läbi enne, kui need main-harusse jõuavad, ja otsustab: kas võib liita või tuleb parandada. Kogu teekond näeb välja nii:
- ÜlevaatajaFiles changedLoeb muudetud ridu ja võrdleb neid nõuetega
- ÜlevaatajaKommentaarid ridadele„+“ rea juures → tekst → Add single comment
- ÜlevaatajaReview changesÜldine tagasiside ja üks kolmest otsusest → Submit review
Mida koodis vaadata
Kas kood teeb seda, mis ülesandes kirjas? Kontrolli piirväärtusi nagu testidisainis.
Koodi on lihtne lugeda: arusaadavad nimed, midagi üleliigset — ei silumisväljundit ega välja kommenteeritud ridu.
Kontrollime. Koodis on viga: üks nõue pole täidetud. Millise otsuse valid Review changes all?
Selge! Avan PR-i.
Pull Requesti ülevaatus
Samm 1 · Files changed
Siin on Marko PR. Vahekaardil Conversation on kirjeldus: mis on tehtud ja millised on ülesande nõuded. Loe need läbi: nende järgi kontrollid koodi.
Nõuded on selged. Kus kood on?
Ava vahekaart Files changed: seal on näha, millised failid ja read muutusid. Rohelised read märgiga + on lisatud.
Vihje
PR-i vahekaardid on pealkirja all: Conversation · Commits · Files changed.
- Files changed
- Kommentaarid
- Request changes
- Parandus
- Approve
- Merge
PR-is on üks uus fail src/discount.js: funktsioon saab tellimuse summa ja tagastab allahindluse protsentides. Ridu pole palju, kuid ülevaataja loeb iga rea.
Millest alustada?
Samm 2 · Nõuete kontroll
Nõuetest. Leia koodist iga nõude tingimus. Eriti tähelepanelik ole piiridega 50 € ja 100 €: millise allahindluse tagastab funktsioon täpselt 100-eurose tellimuse korral?
Vist leidsin! Kuidas reale kommentaari jätta?
Vii kursor vigasele reale — rea numbri kõrvale ilmub sinine +. Vajuta seda, vali või kirjuta kommentaar ja vajuta Add single comment.
Vihje
Nõue: „alates 100 € — allahindlus 10 %“. Leia rida, kus kontrollitakse 100, ja proovi total = 100.
Suurepärane! Tingimus total > 100 ei rakendu täpselt 100 € korral ja ostja saab 10 % asemel 5 %. Hea kommentaar näitab rida, selgitab probleemi ja pakub lahenduse.
Miks leidus viga just väärtusel 100?
Kas rohkem vigu pole?
Samm 3 · Koodi loetavus
Nõuded on kontrollitud. Nüüd loe koodi uuesti, nagu näeksid seda esimest korda: kas iga rida on vajalik? Üleliigsed read teevad lugemise raskemaks ja silumisväljund võib näidata andmeid, mida keegi nägema ei peaks.
Näen üht üleliigset rida.
Leia rida, mida allahindluse arvutamiseks vaja pole, ja kommenteeri seda samamoodi: + → tekst → Add single comment.
Vihje
console.log prindib väärtused konsooli. Nii kontrollitakse koodi arenduse ajal, kuid valmis koodi sellist väljundit ei jäeta.
Jah, console.log jäi alles silumisest. Kaks kommentaari ridadele on valmis — nüüd tuleb ülevaatus kokku võtta.
Kuidas kokku võtta?
Samm 4 · Review changes
Kommentaarid ridadele on detailid. Ülevaatuse tulemuse määrab nupp Review changes: seal kirjutatakse üldine tagasiside ja valitakse üks kolmest otsusest.
Millise otsuse valida?
Vajuta Review changes, kontrolli üldist kommentaari, vali sobiv otsus ja vajuta Submit review.
Vihje
Kood rikub nõuet → PR-i veel liita ei saa. Comment on neutraalne tagasiside, Approve on kinnitus, Request changes palub parandusi.
Ülevaatus on saadetud: PR-is on märge Changes requested ja liitmine on blokeeritud, kuni ülevaataja muudatused kinnitab. Marko sai teavituse ja näeb sinu kommentaare.
Ülevaatus aitab autorit, mitte ei hinda teda: ole konstruktiivne ja viisakas. Võid välja tuua ka selle, mis on hästi tehtud.
Kuidas peaks Marko parandused tegema?
Ootan parandusi!
Samm 5 · Korduv ülevaatus
Marko parandas koodi ja tegi pushi: PR-is on uus commit. Ülevaatus pole veel läbi — veendu, et kõik kommentaarides mainitu on parandatud.
Kontrollin!
Ava Files changed ja kontrolli mõlemat rida. Kui kõik on korras — Review changes → Approve → Submit review.
Vihje
100 € tingimus on nüüd total >= 100 ja console.log on eemaldatud. Märkusi pole — seega PR kinnitatakse.
PR on kinnitatud ja Marko liitis selle main-harusse: muudatused on nüüd projekti osa. Tavaliselt liidab PR-i autor, kui see on kinnitatud ja kontrollid on läbitud.
Valmis!
Suurepärane ülevaatus! Jäta meelde järjekord: Files changed → kommentaarid ridadele + kaudu → Review changes: Comment, Approve või Request changes → Submit review. Kui palud parandusi, vaata pärast autori uut commitit PR uuesti üle.
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).