Home
People
Research
Seminar
Software
Publications
For Students
Links
ContactDoporučené postupy v programování – 3. úkol: Oponentura k API
Nezapomeňte odevzdat tento úkol do 22. 4. 2018 (přes gitlab).
Dvojice pro tento úkol nejsou.
V předchozí části úkolu jste navrhli API pro práci s .ini soubory. V tomto úkolu obdržíte návrh tohoto API některého ze svých kolegů a ohodnotíte jej. Vy na oplátku dostanete hodnocení vašeho API, abyste měli před vlastní implementací zpětnou vazbu o jeho kvalitě.
Zadání úkolu
Tato část úkolu není řešena ve dvojicích. Chceme, aby každý tým dostal 2 hodnocení a měl tak lepší podmínky pro rozhodování, jaké změny API provést.
V rámci této části úkolu obdržíte řešení některého z vašich kolegů. K příslušnému řešení budete mít přístup skrze gitlab.
Vaším úkolem je dodané řešení prozkoumat a napsat stručný text hodnotící jeho kvality i slabiny. Především se zaměřte na:
- popisnost názvů rozhraní (tříd) a metod
- rozdělení zodpovědnosti jednolivých tříd
- přímočarost nebo komplikovanost implementace ukázkového příkladu
Vzhledem k tomu, že cílem druhého úkolu není dodat hotový produkt, není nutné hodnotit věci nesouvisející s vlastním API, jako např.
- chyby v implementaci (pokud nějaká je)
- balíček jako takový (kompilační skript, ukázkové spuštění atd.)
Co odevzdat v rámci tohoto úkolu
Výsledkem vaší práce bude textový soubor ve formátu .md o velikosti 1-2 stran hodnotící dané API. Výsledek commitněte přímo do přiděleného repozitáře pod názvem evaluation.md. Dodržujte opět limit 80 znaků na řádek.
Z různých důvodů se snažíme zachovat pokud možno co největší anonymitu odevzdávaných úkolů. Proto, prosím, nevkládejte do vašich hodnocení údaje, které by vás mohly identifikovat (mail v commit logu je v pořádku, logy odstraníme). Děkujeme.
Hodnocení
U oponentury budeme hodnotit především její věcnost a srozumitelnost. Předpokládáme, že budete psát oponenturu tak, aby obsahovala informace (typ informací), které byste sami rádi viděli. A proto budeme moci za všechny odevzdané oponentury dát plný počet bodů ;-).
Opožděné odevzdání budeme penalizovat ztrátou 3 bodů za každý den zpoždění.
Důvodem penalizace je opět návaznost jednotlivých úloh, kdy neodevzdaná řešení blokují práci ostatním.
Recommended Programming Practices – 3rd assignment: API Review
Do not forget to submit this assignment until 22. 4. 2018 (into gitlab).
There are no pairs for this assignment.
You have designed an API for manipulating .ini files in the last assignment. In this assignment you will be given an API of some other student to review. After that you will be given a review of your API, so that you have a feedback, about your API quality, before implementing the library.
Assignment
This assignment is not done in pairs. We want each team to receive 2 reviews and therefore have a better standpoint for deciding, which changes to make in their API.
In this assignment you will receive an API design of one of your college. You will have an access to it via gitlab.
Your task is to examine the code and write a brief text evaluating its qualities and weaknesses. Focus on:
- how descriptive are the names of interfaces (classes) and methods
- how well is the responsibility divided among classes
- how straightforward or complicated is the implementation of the given example
Because the 2nd assignment was not supposed to deliver the complete implementation, it is not necessary to evaluate anything besides the API, e.g.
- bugs in the implementation (if there is any)
- the solution as a whole (compile script, example to run, etc.)
Submission
The result of your work will be a text file in .md format, 1-2 pages long, which reviews the given API. Commit the review directly into the assigned repository named as evaluation.md. Again, use only 80 characters per line.
For different reasons we are trying to keep the solutions as anonymous as possible. Therefore, please, do not put into the reviews any credentials that could identify your person (mail in commit logs is OK, we will get rid of it). Thank you.
Evaluation
The review will be evaluated based on its accuracy and readability. We assume that you will write the review so that it contains information (type of information), which you would like to see as well. Thus allowing us to give full amount of points to every single review ;-).
Late submission will be penalized by 3 points for each day of delay.
Reason for this penalization is again the continuity of individual assignments. Not submitted solutions are blocking the work of others.
