När du formaterar ett GitHub -problem för MVVMCross kan följande bästa praxis förbättra tydlighet, effektivitet och samarbete. Här är några detaljerade riktlinjer:
1. Beskrivande titlar **
Använd imperativ humör och se till att titeln är tillräckligt beskrivande för att förmedla syftet med frågan. Undvik att avsluta titlar med perioder. Till exempel är "Fix Bug in Data Binding" mer effektivt än "Bug i databindning" eller "Data Binding Bug." [4] [7].2. Rensa översikt **
Ge en kortfattad översikt över problemet i två rader eller mindre. Detta bör inkludera det huvudsakliga målet eller problemet som hanteras. Till exempel "detta problem syftar till att lösa ett databindningsfel som orsakar appolrascher på Android -enheter." [1] [4].3. Beroende (om tillämpligt) **
Om problemet beror på att en annan fråga har lösts först, länk till den frågan. Detta hjälper till att upprätthålla ett tydligt arbetsflöde och säkerställer att beroende uppgifter behandlas i rätt ordning. Till exempel "denna fråga beror på [länk till beroende fråga]." [1].4. Åtgärder **
Formatåtgärder som klickbara checklistor. Detta gör det enkelt att spåra framsteg och tilldela uppgifter till teammedlemmar. Till exempel:- [] Undersök orsaken till databindningsfelet.
- [] Implementera en fix för den identifierade frågan.
- [] Testa fixen på flera plattformar. [1] [4].
5. Resurser/instruktioner **
Inkludera länkar till relevant dokumentation eller resurser som kan hjälpa till att lösa problemet. Detta kan inkludera handledning, API -dokumentation eller tidigare diskussioner relaterade till problemet. Till exempel "se [MVVMCross -dokumentation] (https://mvvmcross.com/docs) för vägledning om databindning." [1] [2].6. Mottagare **
Tilldela frågan till en specifik teammedlem. Detta säkerställer ansvarsskyldighet och tydlighet för vem som är ansvarig för uppgiften. Använd funktionen "Mottagare" i GitHub för att tilldela användare. [1].7. Etiketter **
Tillämpa relevanta etiketter för att kategorisera problemet. Detta hjälper till att filtrera och prioritera frågor inom projektet. Till exempel kan etiketter inkludera "bug", "-funktion" eller "förbättring." [1] [2].8. Projektstyrelse **
Se till att problemet läggs till i projektstyrelsen och trias ordentligt. Detta innebär att ställa in problemstatusen till "Ice Box" om den inte är klar, "prioriterad orderstock" om den är klar men inte tilldelad och "pågår" när den tilldelats. [1].9. Milstolpar **
Använd milstolpar för att spåra framstegen i grupper av frågor eller dragförfrågningar. Detta är särskilt användbart för större projekt eller vid spårning av flera relaterade uppgifter. [1].10. Dokumentation och framstegsuppdateringar **
Uppdatera regelbundet problemkommentarerna med framsteg eller ändringar. Detta håller alla intressenter informerade och underlättar samarbetsproblemlösning. [7].Exempel på en välformaterad fråga
** Titel: Fixa databindningsfel på Android -enheter
** Översikt: Det här problemet behandlar ett databindningsfel som orsakar appolrascher på Android -enheter.
** Beroende: Beror på [länk till beroende fråga].
Åtgärder:
- [] Undersök orsaken till databindningsfelet.
- [] Implementera en fix baserad på resultaten.
- [] genomföra grundliga tester över plattformar.
** Resurser/instruktioner: Se [MVVMCross -dokumentation] (https://mvvmcross.com/docs) för databindningsvägledning.
** Mottagare: @username
** Etiketter: Bug, Android
Genom att följa dessa riktlinjer kan du skapa välstrukturerade GitHub-problem som förbättrar samarbete och effektivitet inom MVVMCross-projektet.
Citeringar:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
]
[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