Quando si forma una questione GitHub per MVVMCRoss, le seguenti migliori pratiche possono migliorare la chiarezza, l'efficienza e la collaborazione. Ecco alcune linee guida dettagliate:
1. Titoli descrittivi **
Usa l'umore imperativo e assicurati che il titolo sia abbastanza descrittivo da trasmettere lo scopo della questione. Evita di porre fine ai titoli con periodi. Ad esempio, "Fix Bug in Data Binding" è più efficace del "bug nel legame dei dati" o "bug di associazione dei dati". [4] [7].2. Cancella panoramica **
Fornire una panoramica concisa del problema in due righe o meno. Ciò dovrebbe includere l'obiettivo principale o il problema. Ad esempio, "Questo problema mira a risolvere un errore di legame dei dati causando arresti anomali sull'app sui dispositivi Android." [1] [4].3. Dipendenza (se applicabile) **
Se il problema dipende da un altro problema che viene risolto per primo, collega a tale problema. Questo aiuta a mantenere un flusso di lavoro chiaro e garantisce che le attività dipendenti siano affrontate nell'ordine corretto. Ad esempio, "Questo problema dipende da [collegamento al problema dipendente]." [1].4. Articoli di azione **
Elementi di azione in formato come liste di controllo cliccabili. Ciò semplifica la monito di tracciare i progressi e assegnare attività ai membri del team. Per esempio:- [] Ricerca la causa dell'errore di legame dei dati.
- [] implementa una soluzione per il problema identificato.
- [] testare la correzione su più piattaforme. [1] [4].
5. Risorse/istruzioni **
Includi collegamenti alla documentazione o alle risorse pertinenti che possono aiutare a risolvere il problema. Ciò potrebbe includere tutorial, documentazione API o discussioni precedenti relative al problema. Ad esempio, "Fare riferimento a [MVVMCRoss Documentation] (https://mvvmcross.com/docs) per una guida sul legame dei dati." [1] [2].6. Assegnati **
Assegna il problema a un membro del team specifico. Ciò garantisce responsabilità e chiarezza su chi è responsabile dell'attività. Utilizzare la funzione "Assegnazioni" in GitHub per assegnare gli utenti. [1].7. Etichette **
Applicare etichette pertinenti per classificare il problema. Questo aiuta a filtrare e dare la priorità ai problemi all'interno del progetto. Ad esempio, le etichette potrebbero includere "bug" "" "" o "miglioramento". [1] [2].8. Project Board **
Assicurarsi che il problema venga aggiunto al progetto di progetto e correttamente triagato. Ciò comporta l'impostazione dello stato del problema in "Ice Box" se non è pronto, "backlog prioritario" se è pronto ma non assegnato e "in corso" una volta assegnato. [1].9. Pietre miliari **
Usa le pietre miliari per tenere traccia dell'avanzamento di gruppi di problemi o richiedere richieste. Ciò è particolarmente utile per progetti più grandi o quando si monitorano più attività correlate. [1].10. Aggiornamenti di documentazione e progressi **
Aggiorna regolarmente i commenti del problema con progressi o modifiche. Ciò mantiene informate tutte le parti interessate e facilita la risoluzione collaborativa dei problemi. [7].Esempio di un problema ben formattato
** Titolo: correggi l'errore di associazione dei dati sui dispositivi Android
** Panoramica: questo problema affronta un errore di rilegatura dei dati causando arresti anomali sull'app sui dispositivi Android.
** Dipendenza: dipende da [collegamento al problema dipendente].
Articoli di azione:
- [] Studia la causa dell'errore di legame dei dati.
- [] implementa una soluzione basata sui risultati.
- [] Condurre test approfonditi su piattaforme.
** Risorse/Istruzioni: fare riferimento a [MVVMCRoss Documentation] (https://mvvmcross.com/docs) per la guida vincolante dei dati.
** Assegnati: @Username
** Etichette: bug, Android
Seguendo queste linee guida, è possibile creare problemi GITHUB ben strutturati che migliorano la collaborazione e l'efficienza all'interno del progetto MVVMCRoss.
Citazioni:[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-tops/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md