Bij het formatteren van een GitHub -probleem voor MVVMCross, kan het volgen van best practices de duidelijkheid, efficiëntie en samenwerking verbeteren. Hier zijn enkele gedetailleerde richtlijnen:
1. beschrijvende titels **
Gebruik een imperatieve stemming en zorg ervoor dat de titel beschrijvend genoeg is om het doel van de kwestie over te brengen. Beëindig het beëindigen van titels met periodes. Bijvoorbeeld, "bug in data binding" is effectiever dan "bug in gegevensbinding" of "data bindende bug". [4] [7].2. Wissen overzicht **
Geef een beknopt overzicht van het probleem in twee regels of minder. Dit moet het hoofddoel of het probleem omvatten dat wordt aangepakt. Bijvoorbeeld: "Dit probleem is bedoeld om een gegevensbindingfout op te lossen die app -crashes op Android -apparaten veroorzaakt." [1] [4].3. Afhankelijkheid (indien van toepassing) **
Als het probleem afhangt van een ander probleem dat eerst wordt opgelost, linkt dan naar dat probleem. Dit helpt bij het handhaven van een duidelijke workflow en zorgt ervoor dat afhankelijke taken in de juiste volgorde worden aangepakt. Bijvoorbeeld: "Dit probleem hangt af van [link naar afhankelijk probleem]." [1].4. Actie -items **
Actie -items opmaken als klikbare checklists. Dit maakt het gemakkelijk om de voortgang bij te houden en taken toe te wijzen aan teamleden. Bijvoorbeeld:- [] Onderzoek de oorzaak van de gegevensbindingfout.
- [] Implementeer een oplossing voor het geïdentificeerde probleem.
- [] Test de oplossing op meerdere platforms. [1] [4].
5. Bronnen/instructies **
Neem links op naar relevante documentatie of bronnen die kunnen helpen bij het oplossen van het probleem. Dit kan tutorials, API -documentatie of eerdere discussies met betrekking tot het probleem omvatten. Bijvoorbeeld: "Zie [MVVMCross -documentatie] (https://mvvmcross.com/docs) voor richtlijnen over gegevensbinding." [1] [2].6. Geesteerders **
Wijs het probleem toe aan een specifiek teamlid. Dit zorgt voor verantwoording en duidelijkheid over wie verantwoordelijk is voor de taak. Gebruik de functie "Toegewezen" in GitHub om gebruikers toe te wijzen. [1].7. Labels **
Pas relevante labels toe om het probleem te categoriseren. Dit helpt bij het filteren en prioriteren van problemen binnen het project. Labels kunnen bijvoorbeeld "bug", "functie", "of" verbetering "bevatten. [1] [2].8. Projectbord **
Zorg ervoor dat het probleem wordt toegevoegd aan het projectbord en correct wordt getrageerd. Dit houdt in dat de probleemstatus wordt ingesteld op "Ice Box" als deze niet klaar is "," prioriteit gegeven aan de achterstand "als het klaar is maar niet wordt toegewezen, en" in uitvoering "eenmaal toegewezen. [1].9. mijlpalen **
Gebruik mijlpalen om de voortgang van groepen problemen of pull -aanvragen bij te houden. Dit is met name handig voor grotere projecten of bij het bijhouden van meerdere gerelateerde taken. [1].10. Documentatie en voortgangsupdates **
Werk het probleem regelmatig bij met voortgang of wijzigingen. Dit houdt alle stakeholders op de hoogte en vergemakkelijkt het oplossen van samenwerking. [7].Voorbeeld van een goed geformatteerd probleem
** Titel: Fouten van gegevensbindende fouten op Android -apparaten repareren
** Overzicht: dit probleem behandelt een gegevensbindende fout die app -crashes op Android -apparaten veroorzaakt.
** Afhankelijkheid: hangt af van [link naar afhankelijk probleem].
Actie -items:
- [] Onderzoek de oorzaak van de gegevensbindingfout.
- [] Implementeer een oplossing op basis van de bevindingen.
- [] Voer grondig testen uit op platforms.
** Bronnen/instructies: raadpleeg [MVVMCross -documentatie] (https://mvvmcross.com/docs) voor gegevensbindende richtlijnen.
** Toegewezen: @UserName
** Labels: bug, Android
Door deze richtlijnen te volgen, kunt u goed gestructureerde GitHub-problemen maken die samenwerking en efficiëntie binnen het MVVMCross-project verbeteren.
Citaten:[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/organisatie-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-ro-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md