Ved formatering af et GitHub -spørgsmål til MVVMCROSS kan efter bedste praksis forbedre klarhed, effektivitet og samarbejde. Her er nogle detaljerede retningslinjer:
1. beskrivende titler **
Brug imperativt humør og sørg for, at titlen er beskrivende nok til at formidle formålet med problemet. Undgå at afslutte titler med perioder. For eksempel er "Fix Bug in Data Binding" mere effektiv end "Bug in Data Binding" eller "Data Binding Fejl." [4] [7].2. klar oversigt **
Giv en kortfattet oversigt over problemet i to linjer eller mindre. Dette bør omfatte hovedmålet eller problemet, der behandles. For eksempel "Dette problem har til formål at løse en databindingsfejl, der forårsager appulykker på Android -enheder." [1] [4].3. afhængighed (hvis relevant) **
Hvis problemet afhænger af, at et andet spørgsmål først løses, skal du linke til dette spørgsmål. Dette hjælper med at opretholde en klar arbejdsgang og sikrer, at afhængige opgaver adresseres i den rigtige rækkefølge. For eksempel "Dette spørgsmål afhænger af [link til afhængigt spørgsmål]." [1].4. Handlingsartikler **
Format Handlingselementer som klikbare tjeklister. Dette gør det nemt at spore fremskridt og tildele opgaver til teammedlemmer. For eksempel:- [] Undersøg årsagen til databindingsfejlen.
- [] Implementere en løsning til det identificerede problem.
- [] Test fixen på flere platforme. [1] [4].
5. Ressourcer/instruktioner **
Medtag links til relevant dokumentation eller ressourcer, der kan hjælpe med at løse problemet. Dette kan omfatte tutorials, API -dokumentation eller tidligere diskussioner relateret til problemet. For eksempel "Se [MVVMCROSS -dokumentation] (https://mvvmcross.com/docs) for vejledning om databinding." [1] [2].6. Andrager **
Tildel problemet til et specifikt teammedlem. Dette sikrer ansvarlighed og klarhed over, hvem der er ansvarlig for opgaven. Brug funktionen "Andetter" i GitHub til at tildele brugere. [1].7. Etiketter **
Anvend relevante etiketter for at kategorisere problemet. Dette hjælper med at filtrere og prioritere problemer inden for projektet. For eksempel kan etiketter omfatte "bug", "funktion" eller "forbedring." [1] [2].8. Project Board **
Sørg for, at problemet føjes til projektbestyrelsen og korrekt triaged. Dette involverer indstilling af problemstatus til "isboks", hvis den ikke er klar, "prioriteret efterslæb", hvis den er klar, men ikke tildelt og "i gang", når den først er tildelt. [1].9. Milepæle **
Brug milepæle til at spore fremskridt med grupper af spørgsmål eller trække anmodninger. Dette er især nyttigt til større projekter eller når man sporer flere relaterede opgaver. [1].10. Dokumentation og fremskridtopdateringer **
Opdater regelmæssigt spørgsmålene med fremskridt eller ændringer. Dette holder alle interessenter informeret og letter samarbejdende problemløsning. [7].Eksempel på et godt formateret problem
** Titel: Fix databindingsfejl på Android -enheder
** Oversigt: Dette problem vedrører en databindingsfejl, der forårsager appulykker på Android -enheder.
** Afhængighed: Afhænger af [link til afhængigt problem].
Handlingsemner:
- [] Undersøg årsagen til den databindingsfejl.
- [] Implementere en løsning baseret på resultaterne.
- [] Foretag grundig test på tværs af platforme.
** Ressourcer/instruktioner: Se [MVVMCROSS -dokumentation] (https://mvvmcross.com/docs) for databindingsvejledning.
** Tilmeldinger: @Username
** Etiketter: Bug, Android
Ved at følge disse retningslinjer kan du oprette velstrukturerede GitHub-spørgsmål, der forbedrer samarbejde og effektivitet inden for MVVMCROSS-projektet.
Citater:[1] https://www.hackforla.org/guide-sides/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/working-with-avanced-formating/organizing-information-with-tables
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-issues/
[5] https://github.com/mvvmcross/mvvmcross-samler
[6] https://github.com/mvvmcross/mvvmcross-sample/blob/master/readme.md
)
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-stil-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md