Issues (teda problémy) sú základom celej komunikácie ohľadom projektu. Pre to je nutné, aby boli čo najlepšie a výstižné.
Dobrý príspevok spĺňa tieto požiadavky:
- Je zaradený aspoň do jeden z labelov
bug
alebopropose
. - Má výstižný a krátky nadpis, ktorý sumarizuje o čo v danom probléme ide.
- Má dlhší popis, ktorý detailne popisuje funkcionalitu v prípade návrhu alebo problém, reprodukciu bugu / chyby.
- Neobsahuje gramatické chyby.
- Obsahuje iba relevantné informácie.
V prípade návrhov, sa ostatní vývojári zapájajú do diskusii pod problémami s labelom input wated
.
Ak sa väčšina zhodne na tom, že daný návrh je dobrý a mal by byť do hry pridaný, dostane label accepted
.
Pre jednú funkcionalitu (napr. tekutiny) by mal existovať jeden propose request, ktorý bude popisovať všetky už jednotilvé tekutiny v hre (nebude mať každá tekutina svoj propose request).
Každý bug report obsahuje popis problému, kroky k reprodukcii, prípadne screenshot alebo video ukazujúce problém.
Pred vytvorením bug reportu sa presvedč, že neexistuje duplicitný bug report!