Při formátování problému GitHub pro MVVMCross může podle osvědčených postupů zvýšit jasnost, efektivitu a spolupráci. Zde je několik podrobných pokynů:
1.. Popisný tituly **
Použijte nezbytnou náladu a ujistěte se, že název je dostatečně popisný, aby zprostředkoval účel problému. Vyvarujte se ukončení titulů s obdobími. Například „oprava chyby ve vazbě dat“ je efektivnější než „chyba v vazbě na data“ nebo „chyba vázání dat“. [4] [7].2. Clear Přehled **
Poskytněte stručný přehled o problému ve dvou nebo méně řádcích. To by mělo zahrnovat hlavní cíl nebo problém, který byl řešen. Například: „Cílem tohoto problému je vyřešit chybu vazby dat, která způsobuje, že na zařízeních pro Android dojde k selhání aplikace.“ [1] [4].3. závislost (pokud je to použitelné) **
Pokud problém závisí na tom, že se nejprve vyřeší další problém, odkazujte na tento problém. To pomáhá udržovat jasný pracovní postup a zajišťuje, že závislé úkoly jsou řešeny ve správném pořadí. Například „tento problém závisí na [odkazu na závislé vydání].“ [1].4. akční položky **
Formát Akce Položky jako kontrolní seznamy kliknutí. Díky tomu je snadné sledovat pokrok a přiřadit úkoly členům týmu. Například:- [] Zkoumejte příčinu chyby vazby dat.
- [] Implementujte opravu identifikovaného problému.
- [] Testujte opravu na více platformách. [1] [4].
5. Zdroje/pokyny **
Zahrnout odkazy na příslušnou dokumentaci nebo zdroje, které mohou pomoci při řešení problému. To může zahrnovat návody, dokumentaci API nebo předchozí diskuse týkající se problému. Například „Pokyny pro vazbu dat naleznete v [MVVMCross Documentation] (https://mvvmcross.com/docs).“ [1] [2].6. Asteanties **
Přiřaďte problém konkrétnímu členovi týmu. Tím je zajištěno odpovědnosti a jasnost, kdo je za úkol odpovědný. K přiřazení uživatelů použijte funkci „nabyvatelé“ v GitHubu. [1].7. Štítky **
Na kategorizaci problému použijte příslušné štítky. To pomáhá při filtrování a upřednostňování problémů v rámci projektu. Například štítky mohou zahrnovat „Bug“, „Funkce“ nebo „Vylepšení“. [1] [2].8. Deska projektu **
Zajistěte, aby byl problém přidán do projektové rady a správně triaged. To zahrnuje nastavení stavu problému na „Ice Box“, pokud není připraven, „upřednostňovaný backlog“, pokud je připraven, ale nepřiřazený a „probíhá“, jakmile bude přiděleno. [1].9. Milestony **
Použijte milníky ke sledování průběhu skupin problémů nebo žádosti o plnění. To je zvláště užitečné pro větší projekty nebo při sledování více souvisejících úkolů. [1].10. Dokumentace a aktualizace pokroku **
Pravidelně aktualizujte připomínky problému s pokrokem nebo změnami. To udržuje všechny zúčastněné strany informované a usnadňuje řešení problémů s spoluprací. [7].Příklad dobře formátovaného problému
** Název: Opravte chybu vazby dat na zařízeních pro Android
** Přehled: Tento problém se zabývá chybou vazby dat, která způsobuje, že aplikace na zařízení Android dopadne.
** Závislost: Závisí na [odkazu na závislé vydání].
Akční položky:
- [] Prozkoumejte příčinu chyby vazby dat.
- [] Implementujte opravu na základě zjištění.
- [] Proveďte důkladné testování napříč platformami.
** Zdroje/pokyny: Viz [MVVMCross Documentation] (https://mvvmcross.com/docs) pro pokyny pro vazbu dat.
** Nastavovatelé: @Username
** Štítky: Bug, Android
Dodržováním těchto pokynů můžete vytvořit dobře strukturované problémy GitHub, které zvyšují spolupráci a efektivitu v rámci projektu MVVMCross.
Citace:[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/organizing-information-with tabulky
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-issues/
[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-ssues-best-practices-and-pro-tips/
[8] https://www.mvvmcross.com/documentation/Contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md