Koodikatselmointi

Koodikatselmointi on osa Tiran harjoitustyötä. Katselmoinnista voi saada maksimissaan 2 pistettä / kerta.

Tämän katselmoinnin perimmäinen tarkoitus on oppia hahmottamaan toisen henkilön kirjoittamaa koodia ja kokonaista ohjelmointiprojektia. Toisten koodia luetaan kursseilla toistaiseksi valitettavan vähän, vaikka sujuva koodinlukutaito on välttämätön taito ohjelmoijan työssä. Hyvin suoritettu katselmointi on tehokas tapa havaita ongelmakohtia ja korjata virheitä mahdollisimman varhaisessa vaiheessa ohjelmointiprojektia.

Ohjeet

Näet sinulle osoitetun katselmointikohteen repositoriolinkin labtoolista koodikatselmoinnin käynnistyttyä. Sinun tehtävänäsi on lukea läpi toisen opiskelijan harjoitustyö ja antaa siitä rakentavaa palautetta. Ohjelmaa kannattaa kokeilla myös suorittaa. Jos projekti on kuitenkin täysin tyhjä runko, niin ota yhteyttä ohjaajaan, niin saat toisen katselmointikohteen.

• Lataa zip-pakattu projekti koneellesi annetun repositorion ZIP -painikkeesta
• Ota talteen kellonaika ja päivä, jolloin latasit projektin
• Pura projekti
• Lue ensimmäiseksi projektin aihemäärittely
• Tutustu mahdollisimman kattavasti ohjelmakoodiin sekä testeihin
• Kokeile myös avata projekti Netbeansissa ja aja testit
• Yritä ymmärtää, mitä mikäkin luokka ja metodi tekee
• Ole sinnikäs: Kaikkea ei aina osaa, eikä tarvitsekaan ymmärtää!
• Kun olet tutustunut riittävän tarkasti toisen projektiin, on aika antaa toiselle henkilölle palaute. Palautteessa ei tarvitse ottaa kantaa ohjelman dokumentointiin tai ulkonäköön.

Palautteenanto

Palautteessasi kerro toiselle opiskelijalle, missä on parannettavaa. Mitä tarkempi palaute, sen arvokkaampaa se on palautteen saajalle. Osatessasi voit antaa vinkkejä siitä, miten asioita voisi tehdä toisin tai onko ohjelman rakenteessa parannettavaa. Jos havaitsit selkeitä bugeja tai virheellistä koodia, kerro siitä. Kannattaa kertoa myös, jos jotkin testit eivät toimineet tai projekti ei käänny. Tarkoitus ei ole tehdä labtoolin-tyylisiä hieman pintapuolisia mainintoja, vaan tutkia koodia tarkasti ja antaa täsmällisiä parannusehdotuksia. Muista myös positiivinen palaute!

Palaute annetaan Githubin Issuena:

• Mene selaimellasi toisen opiskelijan repositorioon
• Valitse välilehti Issues
• Valitse oikeasta reunasta New Issue
• Anna otsikko "Koodikatselmointi"
• Kirjoita palautteesi kommenttilaatikkoon, Preview -välilehdestä näet palautteesi ulkomuodon
• Kommenttilaatikon yläpuolella on linkki tekstin muotoiluohjeisiin
• Palautelaatikko tukee myös kuvia
• Varmuuden vuoksi kopioi kirjoittamasi palaute koneellesi tekstitiedostoon
• Lisää palautteen alkuun päivä ja kellonaika, jolloin latasit annetun projektin
• Lähetä palaute valitsemalla Submit new issue
• Issue eli tässä tapauksessa palaute on koko repositorion tapaan julkinen, joten sen voi lukea kuka tahansa.
• Ohjaajat lukevat ja pisteyttävät annetun palautteen mahdollisimman pian deadlinen jälkeen.

Katselmoinnista jaetaan 0-2 pistettä. Vähintään 4 laadukasta ja rakentavaa palautekommenttia riittää 2 pisteeseen. Palaute kirjoitetaan vapaamuotoisena, mutta yritä kirjoittaa selkeästi. Jaa palaute eri luokista eri kappaleisiin. Jos kirjoitat ranskalaisia viivoja, kirjoita kokonaisia lauseita tai mieluiten useita lauseita. Älä hyökkää palautteessa toista kohtaan! Toisaalta älä ota annettua palautetta itseesi - projektisihan on yhä kesken ja muokattavissa. Palautteen antajakin toisinaan ymmärtää väärin tai antaa virheellisiä ohjeita.

Huom. Katselmoinnin kohteen projekti saattaa elää tai päivittyä sillä aikaa, kun kirjoitat palautetta. Tämän vuoksi palautteeseen liitetään aika, jolloin projektin kävi lataamassa itsellensä. Muulla tavalla asiaan ei kiinnitetä tällä kurssilla huomiota, eikä katselmoijan tarvitse aktiivisesti yrittää tarkistaa, jos jokin asia onkin ehtinyt jo muuttumaan. Palaute voi siis olla osin jo vanhentunutta.