Katselmoinnista voi saada maksimissaan 2 pistettä.
Kurssilla tapahtuvan katselmoinnin perimmäinen tarkoitus on oppia hahmottamaan toisen henkilön kirjoittamaa koodia ja kokonaista ohjelmointiprojektia. Sujuva koodinlukutaito on välttämätön taito ohjelmoijan työssä. Toisten koodia luetaan kuitenkin laitoksen kursseilla toistaiseksi valitettavan vähän. Hyvin suoritettu katselmointi on tehokas tapa havaita koodista ongelmakohtia ja virheitä sekä parantaa koodin laatua.
Katselmointiin käytettyä aikaa ei merkata työaikakirjanpitoon
Katselmointi alkaa ke 02.12. klo 23:59, jonka jälkeen viimeistään näet sinulle osoitetun katselmointikohteen repositoriolinkin labtoolista
Tehtävänäsi on lukea läpi toisen opiskelijan harjoitustyö ja antaa siitä rakentavaa palautetta. Ohjelmaa kannattaa kokeilla myös suorittaa.
- Lataa katselmointikohteesi zip-pakattu projekti koneellesi
- Ota talteen kellonaika ja päivä, jolloin latasit projektin
- Pura projekti
- Voit halutessasi kloonata repositorion koneellesi
- Aloita lukemalla projektin vaatimusmäärittely
- Tutustu mahdollisimman kattavasti ohjelmakoodiin sekä testeihin
- Kokeile myös avata projekti Netbeansissa ja suorita testit
- Yritä ymmärtää, mitä mikäkin luokka ja metodi tekee
- Ole sinnikäs: kaikkea ei aina osaa, eikä tarvitsekaan ymmärtää!
- Haastavin osuus lienee luokkien suhde toisiinsa. Käytä hyväksesi koodista tehtyjä luokkakaavioita
Kun olet tutustunut riittävän tarkasti katselmoitavaan projektiin, on aika antaa toiselle koodista palaute. Palautteessa ei tarvitse ottaa kantaa ohjelman dokumentointiin, ulkonäköön tai toimivuuteen. Tärkeintä on kiinnittää huomiota Ohjelmoinnin perusteissa ja Ohjelmoinnin jatkokurssilla opittuihin hyviin käytänteisiin sekä tällä kurssilla noudatettaviin koodin laatuvaatimuksiin.
Kerro palautteessasi katselmoitavan ohjelman tekijälle, missä on parannettavaa. Mitä tarkempi palaute, sen arvokkaampi se on palautteen saajalle. Voit antaa vihjeitä siitä, miten asioita voisi tehdä toisin. Jos havaitsit selkeitä bugeja tai virheellistä koodia, raportoi niistä. Kannattaa 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
- Lisää lopuksi Labtooliin linkki palautteeseesi
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 6 laadukasta ja rakentavaa palautekommenttia riittää 1.5 pisteeseen. Täysiin pisteisiin edellytetään myös vähintään yksi käyttökelpoinen parannusehdotus.
Palaute kirjoitetaan vapaamuotoisena, mutta yritä kirjoittaa selkeästi. Jaa palaute eri luokista/metodeista eri kappaleisiin. Jos kirjoitat ranskalaisia viivoja, kirjoita kokonaisia lauseita tai mieluiten useita lauseita. Älä hyökkää palautteessa toista kohtaan! Toisaalta älä ota saamaasi 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.