Koodikatselmointi

[ismomehdi]

13.12.2023 17:49

• Näyttävän oloinen projekti! Pisteet kattavasta ja selkeästä dokumentaatiosta. Minulla ei ole omaa kokemusta GitLabista tai Jirasta, joten kommentoin projektia yleisellä tasolla.
• Valitettavasti en saanut ohjelmaa käyntiin koneellani. Käynnistys tyssäsi tähän virheviestiin ja kyseessä lienee ongelma Python 3.11 ja Invoken yhteensopivuuden kanssa. Tässä keskustelua aiheeseen liittyen.
• Koodi on siistiä ja jaettu järjestelmällisesti eri luokkiin ja tiedostoihin.
• Huomasin, että monet docstring-kommentit olivat vielä kesken; otin itse kokeiluun GitHub Copilot-lisäosan ja suosittelen sitä lämmöllä. Se voi nopeuttaa esimerkiksi docstring-kommentointia.
• Attribuuttien nimet olivat kuvaavia ja hyviä. Ne helpottivat koodin lukemista (ja ymmärrystä).
• Projektista löytyi jonkin verran luokkametodeja, jotka eivät käsittääkseni tarvitse luokkametodidekoraattoria. Esimerkkinä luokassa Formatter funktiot transform_dict_items_into_issues ja fix_issue_attribute_names.
• Bongasin muutaman typon dokumentaatiosta:

README:
tuelvat, Toteutuksestsa, asenetaan, ohjelam, annettacaa, kyätetäänkö

Vaatimusmäärittely:
Toiminnalliisuudet

Arkkitehtuuri:
Ohjelam, listna, vastuasten

• Hyvää työtä. Tsemppiä ohjelman loppuunviemiseen!