Atunci când formatați o problemă GitHub pentru MVVMcross, urmarea celor mai bune practici poate spori claritatea, eficiența și colaborarea. Iată câteva orientări detaliate:
1. Titluri descriptive **
Folosiți starea de spirit imperativă și asigurați -vă că titlul este suficient de descriptiv pentru a transmite scopul problemei. Evitați încheierea titlurilor cu perioade. De exemplu, „Remediați eroarea în legarea datelor” este mai eficientă decât „Bug in Data Binding” sau „Bug Bing Binding Date” [4] [7].2. Prezentare generală clară **
Oferiți o imagine de ansamblu concisă a problemei în două linii sau mai puțin. Aceasta ar trebui să includă obiectivul principal sau problema abordată. De exemplu, „această problemă își propune să rezolve o eroare de legare a datelor care determină prăbușirea aplicațiilor pe dispozitivele Android.” [1] [4].3. Dependență (dacă este cazul) **
Dacă problema depinde de faptul că o altă problemă este rezolvată mai întâi, conectați -vă la această problemă. Acest lucru ajută la menținerea unui flux de lucru clar și asigură că sarcinile dependente sunt abordate în ordinea corectă. De exemplu, „această problemă depinde de [link către problema dependentă].” [1].4. Elemente de acțiune **
Formatează elementele de acțiune ca liste de verificare. Acest lucru face ușor să urmăriți progresul și să atribuiți sarcini membrilor echipei. De exemplu:- [] Cercetează cauza erorii de legare a datelor.
- [] Implementați o soluție pentru problema identificată.
- [] Testați fixarea pe mai multe platforme. [1] [4].
5. Resurse/instrucțiuni **
Includeți link -uri către documentația sau resursele relevante care pot ajuta la rezolvarea problemei. Aceasta poate include tutoriale, documentație API sau discuții anterioare legate de problemă. De exemplu, „consultați [documentația MVVMcross] (https://mvvmcross.com/docs) pentru îndrumări privind legarea datelor.” [1] [2].6. ASIGAȚII **
Alocați problema unui anumit membru al echipei. Acest lucru asigură responsabilitatea și claritatea cu privire la cine este responsabil pentru sarcină. Utilizați caracteristica „Assignees” din GitHub pentru a atribui utilizatori. [1].7. Etichete **
Aplicați etichete relevante pentru a clasifica problema. Acest lucru ajută la filtrarea și prioritizarea problemelor din cadrul proiectului. De exemplu, etichetele ar putea include „bug”, „caracteristică” sau „îmbunătățire”. [1] [2].8. PROIECTUL PROIECTULUI **
Asigurați -vă că problema este adăugată la placa de proiect și triată în mod corespunzător. Aceasta implică setarea stării problemei la „Ice Box” dacă nu este gata ”, prioritare Backlog” dacă este gata, dar neasignat și „în curs” odată atribuit. [1].9. Milestones **
Utilizați repere pentru a urmări progresul grupurilor de probleme sau a solicita solicitări. Acest lucru este util în special pentru proiecte mai mari sau atunci când urmăriți mai multe sarcini conexe. [1].10. Actualizări de documentare și progres **
Actualizați în mod regulat problema comentariilor cu progres sau modificări. Acest lucru menține toate părțile interesate informate și facilitează rezolvarea problemelor colaborative. [7].Exemplu de o problemă bine formatată
** Titlu: Remediați eroarea de legare a datelor pe dispozitivele Android
** Prezentare generală: Această problemă abordează o eroare de legare a datelor care provoacă prăbușiri de aplicații pe dispozitivele Android.
** Dependență: depinde de [link către problema dependentă].
Elemente de acțiune:
- [] Cercetați cauza erorii de legare a datelor.
- [] Implementați o soluție bazată pe constatări.
- [] efectuează teste minuțioase pe platforme.
** Resurse/instrucțiuni: consultați [documentația MVVMcross] (https://mvvmcross.com/docs) pentru îndrumarea de legare a datelor.
** Assortari: @USerName
** Etichete: Bug, Android
Urmând aceste orientări, puteți crea probleme de GitHub bine structurate care să sporească colaborarea și eficiența în cadrul proiectului MVVMCross.
Citări:[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-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