Pri oblikovanju izdaje GitHub za MVVMcross lahko sledenje najboljšim praksam poveča jasnost, učinkovitost in sodelovanje. Tu je nekaj podrobnih smernic:
1. Opisni naslovi **
Uporabite imperativno razpoloženje in zagotovite, da je naslov dovolj opisnik, da lahko prenesete namen vprašanja. Izogibajte se koncu naslovov z obdobji. Na primer, "popravite napako v vezavi podatkov" je učinkovitejše od "napak v vezavi podatkov" ali "Podatkovni vezavni napaki." [4] [7].2. Jasni pregled **
Navedite jedrnat pregled te težave v dveh vrsticah ali manj. To bi moralo vključevati glavni cilj ali težavo, ki se reši. Na primer, "Cilj tega vprašanja je rešiti napako, ki veže podatke, ki povzročajo zrušitev aplikacij na napravah Android." [1] [4].3. Odvisnost (če je primerno) **
Če je težava odvisna od tega, da se druga vprašanja najprej reši, povezava do tega vprašanja. To pomaga ohranjati jasen potek dela in zagotavlja, da so odvisne naloge obravnavane v pravilnem vrstnem redu. Na primer, "to vprašanje je odvisno od [povezave do odvisnega vprašanja]." [1].4. akcijski predmeti **
Oblikujte elemente dejanj kot kontrolne sezname, ki jih je mogoče klikniti. To olajša spremljanje napredka in dodelitev nalog članom ekipe. Na primer:- [] Raziščite vzrok napake vezave podatkov.
- [] Izvedite popravek za identificirano težavo.
- [] preizkusite popravek na več platformah. [1] [4].
5. Viri/navodila **
Vključite povezave do ustrezne dokumentacije ali virov, ki lahko pomagajo pri reševanju težave. To lahko vključuje vaje, dokumentacijo API ali prejšnje razprave, povezane s težavo. Na primer, "glejte [mvvmcross dokumentacija] (https://mvvmcross.com/docs) za vodenje vezave podatkov." [1] [2].6. prejemniki **
To težavo dodelite določenemu članu ekipe. To zagotavlja odgovornost in jasnost, kdo je odgovoren za nalogo. Za dodelitev uporabnikov uporabite funkcijo "Prejasniki" v GitHubu. [1].7. Oznake **
Uporabite ustrezne nalepke za kategorizacijo vprašanja. To pomaga pri filtriranju in določanju prednosti vprašanj v projektu. Na primer, nalepke lahko vključujejo funkcijo "Bug", "" ali "izboljšanje." [1] [2].8. Projektna plošča **
Zagotovite, da je težava dodana v projektni odbor in pravilno triad. To vključuje nastavitev stanja izdaje na "Ice Box", če ni pripravljen ", je prednostno zaostajal", če je pripravljen, vendar je bil dodeljen in "v teku", ko je bil dodeljen. [1].9. mejniki **
Uporabite mejnike za spremljanje napredka skupin vprašanj ali vleke zahtev. To je še posebej koristno za večje projekte ali pri sledenju več povezanih nalogah. [1].10. Posodobitve dokumentacije in napredka **
Redno posodabljanje težav s komentarji z napredkom ali spremembami. To vse zainteresirane strani obvešča in olajša skupno reševanje problemov. [7].Primer dobro oblikovane številke
** Naslov: Popravite napako vezave podatkov na napravah Android
K
** Odvisnost: Odvisno od [povezave do odvisnega vprašanja].
Akcijski predmeti:
- [] raziščite vzrok napake vezave podatkov.
- [] Izvedite popravek na podlagi ugotovitev.
- [] izvedite temeljito testiranje po platformah.
** Viri/Navodila: Glej [MVVMcross Dokumentacija] (https://mvvmcross.com/docs) za vodenje podatkov.
** Prejasnik: @Username
** Oznake: Bug, Android
Z upoštevanjem teh smernic lahko ustvarite dobro strukturirane težave GitHub, ki izboljšajo sodelovanje in učinkovitost v okviru projekta MVVMcross.
Navedbe:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/sl/get-started/writing-on-github/working-with-advanced-formating/organizing-information-with-tables
[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-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