MVVMCROSS -i jaoks GitHubi probleemi vormindamisel võib parimate tavade järgimine parandada selgust, tõhusust ja koostööd. Siin on mõned üksikasjalikud juhised:
1. Kirjeldavad pealkirjad **
Kasutage hädavajalikku meeleolu ja veenduge, et pealkiri oleks piisavalt kirjeldav, et probleemi eesmärki edastada. Vältige pealkirjade lõpetamist perioodidega. Näiteks on "andmete sidumisel viga parandamine" tõhusam kui "vea andmete sidumisel" või "andmete sidumise viga". [4] [7].2. selge ülevaade **
Andke selle teema kokkuvõtlik ülevaade kahes või vähem real. See peaks hõlmama peamist eesmärki või probleemi, mida käsitletakse. Näiteks "selle probleemi eesmärk on lahendada andmete sidumisviga, mis põhjustab rakenduse kukkumisi Android -seadmetes." [1] [4].3. Sõltuvus (kui see on vajalik) **
Kui küsimus sõltub sellest, kas mõni teine teema lahendatakse kõigepealt, link selle teemaga. See aitab säilitada selget töövoogu ja tagab sõltuvate ülesannete lahendamise õiges järjekorras. Näiteks "see teema sõltub [link sõltuvast probleemist]." [1].4. Toimingud **
Vormindage toimingute üksused klõpsatavate kontrollnimekirjadena. See muudab edusammude jälgimise ja meeskonna liikmetele ülesannete määramise lihtsaks. Näiteks:- [] Uurige andmete sidumisvea põhjust.
- [] Rakendage tuvastatud probleemi lahendamine.
- [] Testige parandust mitmel platvormil. [1] [4].
5. Ressursid/juhised **
Lisage lingid asjakohasele dokumentatsioonile või ressurssidele, mis võivad selle probleemi lahendamisel aidata. See võib hõlmata õpetusi, API -dokumente või varasemaid probleemiga seotud arutelusid. Näiteks "andmete sidumise juhendamiseks lugege [MVVMCROSS -i dokumentatsioon] (https://mvvmcross.com/docs)." [1] [2].6.
Määrake küsimus konkreetsele meeskonnaliikmele. See tagab vastutuse ja selguse selle üle, kes ülesande eest vastutab. Kasutajate määramiseks kasutage GitHubis funktsiooni "Ülemsaatjad". [1].7. Sildid **
Rakendage selle probleemi liigitamiseks asjakohaseid silte. See aitab projekti raames filtreerida ja tähtsustada. Näiteks võivad sildid sisaldada "viga", funktsiooni "või" täiustamist. "[1] [2].8. projekti juhatus **
Veenduge, et probleem lisatakse projekti juhatusele ja korralikult kolmik. See hõlmab probleemi oleku seadistamist "Ice Box", kui see pole valmis, "prioriteetseks mahajäämus", kui see on valmis, kuid ei määratlemata, ja "pooleli", kui see on määratud. [1].9. verstapostid **
Kasutage verstaposte, et jälgida probleemide rühmade edusamme või tõmbetaotlusi. See on eriti kasulik suuremate projektide jaoks või mitme seotud ülesande jälgimisel. [1].10. Dokumentatsioon ja edu värskendused **
Uuendage väljaande kommentaare regulaarselt edusammude või muudatustega. See hoiab kõik sidusrühmad kursis ja hõlbustab ühist probleemide lahendamist. [7].Näide hästi vormindatud teemast
** Pealkiri: parandage andmete sidumisviga Androidi seadmetes
** Ülevaade: selles väljaandes käsitletakse andmete sidumisviga, mis põhjustab rakenduse kukkumist Android -seadmetes.
** Sõltuvus: sõltub [link sõltuva teemaga].
Tegevuse üksused:
- [] uurige andmete sidumisvea põhjust.
- [] Rakendage parandus leidude põhjal.
- [] Viige läbi põhjaliku testimise platvormides.
** Ressursid/juhised: andmete sidumise juhendamist lugege [mvvmcross dokumentatsioon] (https://mvvmcross.com/docs).
** Omandajad: @UserName
** Sildid: viga, android
Neid juhiseid järgides saate luua hästi struktureeritud GitHubi probleeme, mis suurendavad koostööd MVVMCROSSi projektis.
Tsitaadid:[1] https://www.hackforla.org/guide-poes/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-sterted/writing-on-github/working-with-advanced-formating/organizing-information-with-trables
]
[5] https://github.com/mvvmcross/mvvmcrosssambles
[6] https://github.com/mvvmcross/mvvmcross-amples/blob/master/readme.md
]
]
[9] https://github.com/mvvmcross/mvvmcross/blob/develop