Az MVVMCross GitHub -problémájának formázásakor a bevált gyakorlatok követése javíthatja az egyértelműség, a hatékonyságot és az együttműködést. Íme néhány részletes útmutató:
1. Leíró címek **
Használjon imperatív hangulatot, és gondoskodjon arról, hogy a cím elég leíró legyen a probléma céljának közvetítéséhez. Kerülje a címek befejezését az időszakokkal. Például a "Fix hiba az adatkötésben" hatékonyabb, mint a "Hib az adatkötésben" vagy az "adatkötési hiba". [4] [7].2. Törölje az áttekintést **
Adjon meg tömör áttekintést a kérdésről két sorban vagy annál kevesebb sorban. Ez magában foglalja a foglalkoztatott fő célt vagy problémát. Például: "Ez a probléma célja az adatkötési hiba megoldása, amely az alkalmazás összeomlásait okozza az Android -eszközökön." [1] [4].3. Függőség (ha van) **
Ha a probléma attól függ, hogy egy másik problémát először megoldanak, linkre kerül a kérdésre. Ez elősegíti a világos munkafolyamat fenntartását, és biztosítja, hogy a függő feladatokat a megfelelő sorrendben kezeljék. Például: "Ez a kérdés a [link a függő kérdéshez]." [1].4. Action elemek **
A műveleti elemek formázása kattintható ellenőrző listákként. Ez megkönnyíti az előrehaladás nyomon követését és a csapattagok feladatainak kiosztását. Például:- [] Vizsgálja meg az adatkötési hiba okát.
- [] Végezze el az azonosított kérdés javítását.
- [] tesztelje a javítást több platformon. [1] [4].
5. Források/utasítások **
Tartalmazza a linkeket a releváns dokumentációra vagy az erőforrásokra, amelyek segítenek a probléma megoldásában. Ez magában foglalhatja az oktatóanyagokat, az API -dokumentációt vagy a problémával kapcsolatos korábbi megbeszéléseket. Például: "Lásd az [MVVMCross dokumentáció] (https://mvvmcross.com/docs) útmutatást az adatokkötéssel kapcsolatos útmutatásokra." [1] [2].6.
Rendelje ki a kérdést egy adott csapattaghoz. Ez biztosítja az elszámoltathatóságot és egyértelműséget abban, hogy ki felelős a feladatért. A felhasználók hozzárendeléséhez használja a GitHUB -ban található "Megrendelők" funkciót. [1].7. Címkék **
Alkalmazza a megfelelő címkéket a probléma kategorizálására. Ez elősegíti a problémák szűrésében és prioritásainak prioritása a projekten belül. Például a címkék tartalmazhatják a "Bug", "funkciót" vagy a "javítást". [1] [2].8. Project Board **
Győződjön meg arról, hogy a problémát hozzáadják a projektbizottsághoz, és megfelelően triakozódjanak. Ez magában foglalja a kérdés állapotának beállítása "jégdoboz" -ra, ha még nem áll készen, "prioritási elmaradás", ha készen áll, de nem hozzárendelve, és "folyamatban van", miután hozzárendelték. [1].9. Mérföldkövek **
A mérföldkövek segítségével nyomon követheti a kérdéscsoportok előrehaladását vagy a kéréseket. Ez különösen hasznos nagyobb projekteknél vagy több kapcsolódó feladat követésekor. [1].10. Dokumentáció és előrehaladás frissítései **
Rendszeresen frissítse a kérdés megjegyzéseit előrehaladással vagy változásokkal. Ez minden érdekelt fél tájékoztatását tartja és megkönnyíti az együttműködési problémamegoldást. [7].Példa egy jól formázott kérdésre
** Cím: Javítsa ki az adatkötési hibát az Android eszközökön
** Áttekintés: Ez a probléma egy adatkötési hibát érint, amely az alkalmazás összeomlását okozza az Android -eszközökön.
** Függőség: A [link a függő kérdéshez] függ.
Műveleti tételek:
- [] Vizsgálja meg az adatkötési hiba okát.
- [] A megállapítások alapján történő végrehajtás végrehajtása.
- [] Végezzen alapos tesztelést a platformokon.
** Források/utasítások: Lásd az [MVVMCROSS dokumentáció] (https://mvvmcross.com/docs) adatkötési útmutatást.
** A megbízottak: @USername
** Címkék: Hiba, Android
Ezen iránymutatások betartásával jól strukturált GitHub-kérdéseket hozhat létre, amelyek javítják az együttműködést és a hatékonyságot az MVVMCross projekten belül.
Idézetek:[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-foratting
[4] https://tilburgscienceehub.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-issues-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