hyvaksiluku.md

Kurssin hyväksiluku

Kurssi on mahdollista hyväksilukea, eli ansaita opintopisteet arvosanalla hyväksytty. Hyväksiluvun vaatimuksena on ohjelmointiprojektin toteutus ja dokumentointi. Projektin toteutuksessa käytetty ohjelmointikieli on vapaasti valittavissa, kunhan ohjelman suorittamiseen vaadittavat toimenpiteet on dokumentoitu.

Jos haluat hyväksilukea kurssin, ota sähköpostilla yhteyttä kurssin vastuuopettajaan Matti Luukkaiseen (matti.luukkainen@helsinki.fi).

Projektin vaatimukset

Laajuus

• Projektin toteuttamiseen, testaamiseen ja dokumentointiin käytetyn työajan tulee olla vähintään 80 tuntia
• Sovelluksella täytyy olla jokin käyttöliittymä, esim. komentoriviltä käytettävä tai graafinen käyttöliittymä
• Projektin sovelluslogiikkaa tulee testata, niin että testien rivi- ja haarautumakattavuus on vähintään 60%. Käyttöliittymään liittyvää koodia ei tarvitse testata, joten sen voi jättää kattavuuden ulkopuolelle. Tälle on kuitenkin se vaatimus, että sovelluslogiikan ja käyttöliittymän koodi ovat erillään toisistaan

Koodin laatu

• Sovelluksen koodin tulee noudottaa kurssilla määriteltyjä laatuvaatimuksia. Laatuvaatimuksia saattaa joutua soveltamaan ohjelmointikielestä riippuen
• Sovelluksen koodin tulee olla suurimmilta osin kommenttien avulla dokumentoituta ohjelmointikielen standardien mukaisesti (esim. Javan Javadoc). Tämä tarkoittaa mm. luokkien, metodien ja funktioiden dokumentointia

Versionhallinta ja repositorio

• Projektin lähdekoodin tulee olla [GitHub]-repositoriossa. Repositorio voi olla julkinen ja yksityinen. Jos repositorio on yksityinen, lisää sen kollaboraattoreiksi käyttäjät Kaltsoon ja mluukkai
• Jos ohjelmistostasi on suoritettava binääri (esim. Javan .jar-tiedosto), lisää se GitHub releaseen. Kerro repositorion README.md-tiedossa, mikä release pitää ladata ja miten sen binäärit suoritetaan
• Lisää repositorioon README.md-tiedosto, joka on suurin piirtein kurssin referenssisovelluksen mukainen. Mukana tulee olla vähintään seuraavat asiat:
  • Lyhyt kuvaus projektista
  • Linkit dokumentaatioon
  • Ohjeet ohjelman suorittamiselle
  • Ohjeet testien suorittamiselle

Dokumentaatio

Jokaiseen dokumenttiin tulee olla linkki projektin repositorion README.md-tiedostossa. Dokumentaatiossa tulee olla vähintään seuraavat dokumentit:

• Arkkitehtuurikuvaus, joka on suurin piirtein referenssisovelluksen arkkitehtuurikuvauksen mukainen. Mukana tulee olla vähintään sovelluslogiikan sanallinen kuvaus ja kaavio. Jos sovellus on erittäin laaja, keskity johonkin olennaiseen kokonaisuuteen
• Käyttöohje, joka on suurin piirtein referenssisovelluksen käyttöohjeen mukainen
• Testausdokumentti, joka on suurin piirtein referenssisovelluksen testausdokumentin mukainen.
• Tuntikirjanpito, josta käy ilmi projektin toteuttamiseen käytetyt työtunnit. Referenssisovelluksen mukainen tuntikirjanpito on ihanteellinen, mutta myös karkeampi taso käy. Tärkeintä on, että tutkikirjanpidosta ilmenee, mihin osa-alueeseen työaikaa on käytetty ja kuinka paljon. Muista, että hyväksiluvun vaatimuksena on vähintään 80 työtuntia
• Tuntikirjanpidon voi myös korvata vakuuttavalla selvityksellä siitä, että työhön on käytetty ainakin 80 tuntia aikaa.