blazs / lvr-sat Goto Github PK

Najbrz je nekdo pozabil commitat prevedbe.py

Če bo čas, se lahko naredi tudi to.

Primeri uporabe niso isto kot testi, saj z njimi pokažete, kako se vaša koda uporabi. Dober nabor primerov vsebuje zelo preproste primere, kakor tudi zahtevnejše.

V vašem primeru bomo uporabili primere tudi za ocenjevanje kode, zato je dobro, da s primeri pokažete, kaj vse vaša koda zna, kakor tudi česa ne zna. Objektivno poročanje o zmogljivostih kode se šteje kot velik plus.

Zaželeno, a ne nujno, je, da so primeri zares narejeni kot se šika. Vzemimo na primer sudoku, to lahko implementirate na več načinov:

Uporabnik mora v datoteki py spreminati primer na roko. Rešitev se izpiše tako, da uporabnik vidi valuacijo. Sam mora dešifrirati rešitev in iz nje sestaviti rešeni sudoku.

Uporabnik poda primer sudoku v priročni datoteki *.txt, ki jo vaš program prebere. Rešitev izpiše lepo, da uporabnik neposredno vidi rešitev. V README.md je obrazloženo, kakšen je format vhodne datoteke.

V drugem primeru je jasno, da bo primer sudoku pravzaprav samostojen programček, ki uporablja vaš SAT algoritem. Nič hudega, taki primeri so zelo dobrodošli.

Ko pozenem src/main.py se src/sat.py usuje --- sprozi se assert False, "Nemogoce" iz vrstice 72. Lahko to preveris?

hadamard v prevedbe.py ne dela

Potrebno je napisati dobre teste, ki bodo preverjali delovanje naših funkcij.

• uredi datoteko LICENSE

• komentarji v kodi

Ker je sudoku zelo zanimiva igra, ampak se mi ga ne da vsak dan reševati in razmišljati, moramo prevesti problem na SAT, da ga bomo lahko rešili.

Na spletni učilnici poiščem povezavo na vaš repozitorij.
Malo pogledam repozitorij (commit log, activity, issues) in ga skloniram na svoj računalnik.
Preberem README.md, da ugotovim, kaj ste naredili.
Pogledam kodo in jo poskusim razumeti, pomagam si z README.md in komentarji.
Sledim navodilom v README.md za poganjanje testov.
Zmogljivost vaše kode ocenim tako, da poženem primere. Kako se to naredi, preberem v README.md.
Če se vse zatika in če se počutim kot dresiran kužek, ki mora skakati čez obročke, da sploh karkoli začne delati, potem sem slabe volje.
Če vse leti kot namazano, sem ponosen na svoje študente.
V vsakem koraku se ocenjuje kvaliteta izdelave:

Ali ime skupina razkriva smisel za humor?
Ali kompetentno uporabljate Github?
Ali je README.md razumljiv in ali mi pomaga razumeti, kaj se dogaja?
Ali je koda taka, kot da so kure brskale po njej?
Kako pametno so izbrani testi in kako kvalitetno so izdelani?
Kako zmogljiva je vaša implementacija? Kako hitro dela (ali so mi testi povedali, kako hitro dela)?

• [NAREJENO] uredi readme (opis algoritma + linki do algoritma)
• [NAREJENO] spisek datotek
• navodila uporabe + kratki primeri uporabe

Someone is trashing our GitHub repo with empty files (sudoku.py); please remove all garbage. :-)

• ureditev datoteke (naj ne bo vse v eni datoteki)
• loci splosno kodo, teste in primere uporabe

Preveri kodo prevedbe.

Glede na to, da uporabljate Github, se TODO dela tako, da se naredi nov issue in se tja napiše, kaj je treba narediti. README je namenjen ljudem, ki pridejo pogledat, kaj to je za en projekt.