Formatuojant „MVVMCross“ „GitHub“ problemą, geriausia praktika gali padidinti aiškumą, efektyvumą ir bendradarbiavimą. Čia yra kelios išsamios gairės:
1. Aprašomieji pavadinimai **
Naudokite imperatyvią nuotaiką ir įsitikinkite, kad pavadinimas yra pakankamai aprašomasis, kad perteiktumėte problemos tikslą. Venkite pavadinimų pabaigos laikotarpiais. Pvz., „Ištaisykite duomenų surišimo klaidą“ yra efektyvesnis nei „Duomenų surišimo klaida“ arba „Duomenų surišimo klaida“. [4] [7].2. Išvalyta apžvalga **
Pateikite glaustą šios problemos apžvalgą dviem ar mažiau eilutėmis. Tai turėtų apimti pagrindinį tikslą ar problemą. Pavyzdžiui, „Šiuo klausimu siekiama išspręsti duomenų įrišimo klaidą, dėl kurios programos sudužo„ Android “įrenginiuose.“ [1] [4].3. Priklausomybė (jei taikoma) **
Jei klausimas priklauso nuo to, ar pirmiausia išspręsta kita problema, nuoroda į šią problemą. Tai padeda išlaikyti aiškią darbo eigą ir užtikrina, kad priklausomos užduotys bus nagrinėjamos teisinga tvarka. Pvz., „Šis klausimas priklauso nuo [nuoroda į priklausomą problemą].“ [1].4. Veiksmo elementai **
Formato veiksmo elementai kaip spustelėjami kontroliniai sąrašai. Tai leidžia lengvai sekti pažangą ir priskirti užduotis komandos nariams. Pavyzdžiui:- [] Tyrinėkite duomenų įrišimo klaidos priežastį.
- [] Įdiekite nustatytą problemą.
- [] Išbandykite taisymą keliose platformose. [1] [4].
5. Šaltiniai/instrukcijos **
Įtraukite nuorodas į atitinkamus dokumentus ar išteklius, kurie gali padėti išspręsti problemą. Tai gali apimti vadovėlius, API dokumentus ar ankstesnes diskusijas, susijusias su problema. Pvz., „Žr. [MVVMCROSS dokumentaciją] (https://mvvmcross.com/docs), kad gautumėte duomenų apie duomenų surišimą.“ [1] [2].6. PRANEŠIMAI **
Paskirkite problemą konkrečiam komandos nariui. Tai užtikrina atskaitomybę ir aiškumą už tai, kas yra atsakingas už užduotį. Norėdami priskirti vartotojus, naudokite funkciją „Persarankiai“ „GitHub“. [1].7. Etiketės **
Norėdami suskirstyti į kategorijas, pritaikykite atitinkamas etiketes. Tai padeda filtruoti ir nustatyti prioritetus projekto problemoms. Pvz., Etiketėse gali būti „klaidos“, „funkcija“ arba „patobulinimas“. [1] [2].8. Projekto lenta **
Įsitikinkite, kad problema pridedama prie projekto lentos ir tinkamai sutvarkyta. Tai apima problemos būsenos nustatymą į „Ice Box“, jei jis nėra paruoštas “, prioritetas„ Backlog “, jei jis yra paruoštas, bet nepriskirtas ir„ vykdomas “, kai tik priskirta. [1].9. MILESTONAI **
Naudokite gaires, kad stebėtumėte klausimų grupių eigą arba patraukite užklausas. Tai ypač naudinga didesniems projektams arba stebint kelias susijusias užduotis. [1].10. Dokumentacija ir pažangos atnaujinimai **
Reguliariai atnaujinkite klausimo komentarus su pažanga ar pakeitimais. Tai informuoja visas suinteresuotosios šalys ir palengvina bendradarbiavimo problemų sprendimą. [7].gerai formuojamos problemos pavyzdys
** Pavadinimas: Ištaisykite duomenų įrišimo klaidą „Android“ įrenginiuose
** Apžvalga: Šioje problemoje nagrinėjama duomenų įrišimo klaida, dėl kurios programos sudužo „Android“ įrenginiuose.
** Priklausomybė: priklauso nuo [nuoroda į priklausomą problemą].
Veiksmo elementai:
- [] Ištirkite duomenų įrišimo klaidos priežastį.
- [] Įdiekite pataisą, pagrįstą išvadomis.
- [] Atlikite kruopščius bandymus tarp platformų.
** Šaltiniai/instrukcijos: rasite duomenų įrišimo gaires, skaitykite [MVVMCross dokumentacija] (https://mvvmcross.com/docs).
** PRANEŠIMAI: @USERNAME
** Etiketės: klaida, „Android“
Vykdydami šias gaires, galite sukurti gerai struktūruotas „GitHub“ problemas, kurios padidina bendradarbiavimą ir efektyvumą MVVMCross projekte.
Citatos:[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-lables
[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/masterling-github-issues-best-practices-and-pro-ips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributisting.md