Pri formátovaní problému GitHub pre MVVMCross môže dodržiavanie osvedčených postupov zvýšiť zrozumiteľnosť, efektívnosť a spoluprácu. Tu je niekoľko podrobných pokynov:
1. Opisné tituly **
Používajte imperatívnu náladu a zabezpečte, aby bol názov dostatočne opisný, aby ste sprostredkovali účel problému. Vyvarujte sa ukončenia titulov s obdobím. Napríklad „Oprava chyby v väzbe údajov“ je efektívnejšia ako „chyba v väzbe údajov“ alebo „chyba viazania údajov“. [4] [7].2. Vymazať prehľad **
Poskytnite stručný prehľad o probléme v dvoch alebo menej riadkoch. To by malo zahŕňať hlavný cieľ alebo riešenie problému. Napríklad „Cieľom tohto problému je vyriešiť chybu viazania údajov spôsobujúce zlyhanie aplikácie na zariadeniach Android.“ [1] [4].3. Závislosť (ak je to možné) **
Ak problém závisí od toho, že sa najskôr vyrieši ďalší problém, odkaz na túto otázku. To pomáha udržiavať jasný pracovný tok a zaisťuje, že závislé úlohy sú riešené v správnom poradí. Napríklad „Tento problém závisí od [odkazu na závislú otázku].“ [1].4. Položky akcie **
Akcie Formáty ako kontrolné zoznamy, ktoré je možné kliknúť. To uľahčuje sledovanie pokroku a priraďovanie úloh členom tímu. Napríklad:- [] Preskúmajte príčinu chyby viazania údajov.
- [] implementujte opravu identifikovaného problému.
- [] Otestujte oprávninu na viacerých platformách. [1] [4].
5. Zdroje/pokyny **
Zahrňte odkazy na príslušnú dokumentáciu alebo zdroje, ktoré môžu pomôcť pri riešení problému. To môže zahŕňať návody, dokumentáciu API alebo predchádzajúce diskusie týkajúce sa problému. Usmernenie o väzbe údajov nájdete v prípade „dokumentácie [mvvmcross] (https://mvvmcross.com/docs).“ [1] [2].6. Prístupcovia **
Priraďte problém konkrétnemu členovi tímu. To zaisťuje zodpovednosť a jasnosť toho, kto je zodpovedný za túto úlohu. Na priradenie používateľov použite funkciu „Priradiaci“ v GitHub. [1].7. Štítky **
Na kategorizáciu problému použite príslušné štítky. Pomáha to pri filtrovaní a prioritizácii problémov v rámci projektu. Napríklad štítky môžu obsahovať funkciu „Bug“, „“ alebo „vylepšenie“. [1] [2].8. Projektová doska **
Uistite sa, že problém sa pridá do projektovej rady a riadne triarí. Zahŕňa to nastavenie stavu problému na „Ice Box“, ak nie je pripravený, „uprednostňovaný nevybavený“, ak je pripravený, ale nepriradený a „prebieha“ po pridelení. [1].9. Míľniky **
Použite míľniky na sledovanie pokroku skupín problémov alebo na vytiahnutie žiadostí. Je to užitočné najmä pre väčšie projekty alebo pri sledovaní viacerých súvisiacich úloh. [1].10. Dokumentácia a aktualizácie pokroku **
Pravidelne aktualizujte komentáre problému s pokrokom alebo zmenami. Tým sa všetky zainteresované strany informujú a uľahčuje riešenie problémov s kolaboratívnymi problémami. [7].Príklad dobre formovaného problému
** Názov: Opravte chybu viazania údajov na zariadeniach Android
** Prehľad: Tento problém sa týka chyby viazania údajov spôsobujúce zlyhanie aplikácie na zariadeniach Android.
** Závislosť: Závisí od [odkaz na závislý problém].
Akcie Položky:
- [] Preskúmajte príčinu chyby viazania údajov.
- [] implementujte opravu na základe zistení.
- [] Vykonajte dôkladné testovanie na platformách.
** Zdroje/pokyny: Pozrite si [MVVMCross Dokumentácia] (https://mvvmcross.com/docs), kde nájdete usmernenie o väzbe na údaje.
** Prístupcovia: @username
** Štítky: Bug, Android
Dodržiavaním týchto usmernení môžete vytvoriť dobre štruktúrované problémy GitHub, ktoré zvyšujú spoluprácu a efektívnosť v rámci projektu MVVMCross.
Citácie:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/Working-with-advanced-formatting/organization-information-with-thable
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-isisus/
[5] https://github.com/mvvmcross/mvvmcross-samples
[6] https://github.com/mvvmcross/mvvmcross-samples/blob/master/readme.md
[7] https://gitprotect.io/blog/mastering-github-issues-best-practices-and-pro-trips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-tyle-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md