Når du formaterer et GitHub -problem for MVVMCROSS, kan det å følge beste praksis øke klarhet, effektivitet og samarbeid. Her er noen detaljerte retningslinjer:
1. Beskrivende titler **
Bruk imperativ stemning og sikre at tittelen er beskrivende nok til å formidle formålet med saken. Unngå å avslutte titler med perioder. For eksempel er "Fix Bug in Data Binding" mer effektiv enn "Bug in Data Binding" eller "Data Binding Bug." [4] [7].2. klart oversikt **
Gi en kortfattet oversikt over problemet i to linjer eller mindre. Dette bør omfatte hovedmålet eller problemet som blir adressert. For eksempel, "Dette problemet tar sikte på å løse en databindingsfeil som forårsaker appkrasj på Android -enheter." [1] [4].3. Avhengighet (hvis aktuelt) **
Hvis problemet avhenger av at et annet problem blir løst først, kobler du til den saken. Dette hjelper til med å opprettholde en klar arbeidsflyt og sikrer at avhengige oppgaver blir adressert i riktig rekkefølge. For eksempel "Dette problemet avhenger av [lenke til avhengig problem]." [1].4. Handlingsartikler **
Formater handlinger som klikkbare sjekklister. Dette gjør det enkelt å spore fremgang og tildele oppgaver til teammedlemmer. For eksempel:- [] Undersøk årsaken til databindingsfeilen.
- [] Implementere en løsning for det identifiserte problemet.
- [] Test fiksen på flere plattformer. [1] [4].
5. Ressurser/instruksjoner **
Inkluder lenker til relevant dokumentasjon eller ressurser som kan hjelpe til med å løse problemet. Dette kan omfatte opplæringsprogrammer, API -dokumentasjon eller tidligere diskusjoner relatert til problemet. For eksempel, "Se for eksempel [mvvmcross dokumentasjon] (https://mvvmcross.com/docs) for veiledning om databinding." [1] [2].6. Tilkomne **
Tilordne saken til et spesifikt teammedlem. Dette sikrer ansvarlighet og klarhet i hvem som er ansvarlig for oppgaven. Bruk funksjonen "tiltalte" i Github for å tildele brukere. [1].7. Etiketter **
Bruk relevante etiketter for å kategorisere problemet. Dette hjelper med å filtrere og prioritere problemer i prosjektet. For eksempel kan etiketter inkludere "bug", "-funksjon" eller "forbedring." [1] [2].8. Prosjektstyret **
Forsikre deg om at problemet legges til prosjektstyret og riktig tripet. Dette innebærer å sette problemstatusen til "Ice Box" hvis den ikke er klar, "prioritert etterslep" hvis den er klar, men ikke tildelt, og "pågår" en gang tildelt. [1].9. Milepæler **
Bruk milepæler for å spore fremdriften i grupper av problemer eller trekkforespørsler. Dette er spesielt nyttig for større prosjekter eller når du sporer flere relaterte oppgaver. [1].10. Dokumentasjon og fremdriftsoppdateringer **
Regelmessig oppdatere problemkommentarene med fremgang eller endringer. Dette holder alle interessenter informert og letter samarbeidsoppløsning. [7].Eksempel på et godt formatert problem
** Tittel: Fix Data Binding Feil på Android -enheter
** Oversikt: Dette problemet tar for seg en databindingsfeil som forårsaker appkrasj på Android -enheter.
** Avhengighet: Avhenger av [lenke til avhengig problem].
Handlingsartikler:
- [] Undersøk årsaken til databindingsfeilen.
- [] Implementere en løsning basert på funnene.
- [] Gjennomføre grundig testing på tvers av plattformer.
** Ressurser/instruksjoner: Se [MVVMCROSS Documentation] (https://mvvmcross.com/docs) for databindingsveiledning.
** Tildelinger: @usname
** Etiketter: Bug, Android
Ved å følge disse retningslinjene kan du lage godt strukturerte GitHub-spørsmål som forbedrer samarbeid og effektivitet i MVVMCROSS-prosjektet.
Sitasjoner:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/no/get-started/writing-in-github/working-with-adansed-formatting/organizing-information-with-tables
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-isses/
[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-protips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md