Κατά τη μορφοποίηση ενός ζητήματος GitHub για το MVVMCross, οι βέλτιστες πρακτικές μπορούν να ενισχύσουν τη σαφήνεια, την αποτελεσματικότητα και τη συνεργασία. Ακολουθούν μερικές λεπτομερείς οδηγίες:
1. Περιγραφικοί τίτλοι **
Χρησιμοποιήστε την επιτακτική διάθεση και βεβαιωθείτε ότι ο τίτλος είναι αρκετά περιγραφικός για να μεταφέρει το σκοπό του θέματος. Αποφύγετε τον τερματισμό των τίτλων με περιόδους. Για παράδειγμα, το "Fix Bug σε δέσμευση δεδομένων" είναι πιο αποτελεσματικό από το "σφάλμα σε δέσμευση δεδομένων" ή "σφάλμα δέσμευσης δεδομένων" [4] [7].2. Καθαρή επισκόπηση **
Παρέχετε μια συνοπτική επισκόπηση του θέματος σε δύο γραμμές ή λιγότερο. Αυτό πρέπει να περιλαμβάνει τον κύριο στόχο ή το πρόβλημα που αντιμετωπίζεται. Για παράδειγμα, "Το ζήτημα αυτό στοχεύει στην επίλυση ενός σφάλματος δέσμευσης δεδομένων που προκαλεί συντριβή της εφαρμογής σε συσκευές Android." [1] [4].3. Εξάρτηση (αν υπάρχει) **
Εάν το ζήτημα εξαρτάται πρώτα από το άλλο ζήτημα να επιλυθεί, συνδέεται με αυτό το ζήτημα. Αυτό βοηθά στη διατήρηση μιας σαφούς ροής εργασίας και διασφαλίζει ότι οι εξαρτημένες εργασίες αντιμετωπίζονται με τη σωστή σειρά. Για παράδειγμα, "αυτό το ζήτημα εξαρτάται από το [σύνδεσμο προς το εξαρτημένο ζήτημα]." [1].4. Στοιχεία δράσης **
Στοιχεία δράσης μορφής ως λίστες ελέγχου που μπορούν να κάνουν κλικ. Αυτό διευκολύνει την παρακολούθηση της προόδου και την ανάθεση εργασιών στα μέλη της ομάδας. Για παράδειγμα:- [] Ερευνήστε την αιτία του σφάλματος δέσμευσης δεδομένων.
- [] Εφαρμόστε μια λύση για το προσδιορισμένο ζήτημα.
- [] Δοκιμάστε τη λύση σε πολλές πλατφόρμες [1] [4].
5. Πόροι/Οδηγίες **
Συμπεριλάβετε συνδέσμους με σχετική τεκμηρίωση ή πόρους που μπορούν να βοηθήσουν στην επίλυση του προβλήματος. Αυτό μπορεί να περιλαμβάνει μαθήματα, τεκμηρίωση API ή προηγούμενες συζητήσεις σχετικά με το πρόβλημα. Για παράδειγμα, "Ανατρέξτε στην ενότητα [MVVMCROSS Documentation] (https://mvvmcross.com/docs) για καθοδήγηση σχετικά με τη δέσμευση δεδομένων." [1] [2].6.
Εκχωρήστε το ζήτημα σε ένα συγκεκριμένο μέλος της ομάδας. Αυτό εξασφαλίζει τη λογοδοσία και τη σαφήνεια σχετικά με το ποιος είναι υπεύθυνος για την εργασία. Χρησιμοποιήστε τη λειτουργία "Εκτελεσούς" στο GitHub για να εκχωρήσετε χρήστες [1].7 ετικέτες **
Εφαρμόστε σχετικές ετικέτες για να κατηγοριοποιήσετε το ζήτημα. Αυτό βοηθά στο φιλτράρισμα και την ιεράρχηση των προβλημάτων στο πλαίσιο του έργου. Για παράδειγμα, οι ετικέτες ενδέχεται να περιλαμβάνουν "bug", "χαρακτηριστικό" ή "βελτίωση". [1] [2].8. Πίνακας έργου **
Βεβαιωθείτε ότι το ζήτημα προστίθεται στο συμβούλιο του έργου και είναι κατάλληλα ταξινομημένο. Αυτό περιλαμβάνει τον καθορισμό της κατάστασης του προβλήματος στο "ICE Box" εάν δεν είναι έτοιμο ", προτεραιότητα στην καθυστέρηση" εάν είναι έτοιμο αλλά μη ανασταλμένο και "σε εξέλιξη" που έχει ανατεθεί. [1].9 Ορόσημα **
Χρησιμοποιήστε ορόσημα για να παρακολουθείτε την πρόοδο των ομάδων θεμάτων ή των αιτημάτων έλξης. Αυτό είναι ιδιαίτερα χρήσιμο για μεγαλύτερα έργα ή κατά την παρακολούθηση πολλαπλών σχετικών εργασιών [1].10. Ενημερώσεις τεκμηρίωσης και προόδου **
Ενημερώστε τακτικά τα σχόλια του προβλήματος με πρόοδο ή αλλαγές. Αυτό ενημερώνει όλους τους ενδιαφερόμενους και διευκολύνει τη συνεργατική επίλυση προβλημάτων [7].Παράδειγμα ενός καλά διαμορφωμένου προβλήματος
** Τίτλος: Διορθώστε το σφάλμα δέσμευσης δεδομένων σε συσκευές Android
** Επισκόπηση: Αυτό το ζήτημα ασχολείται με ένα σφάλμα δέσμευσης δεδομένων που προκαλεί συντριβή της εφαρμογής σε συσκευές Android.
** Εξάρτηση: Εξαρτάται από το [σύνδεσμο προς το εξαρτημένο ζήτημα].
Στοιχεία δράσης:
- [] Διερευνήστε την αιτία του σφάλματος δέσμευσης δεδομένων.
- [] Εφαρμόστε μια επιδιόρθωση με βάση τα ευρήματα.
- [] Διεξάγετε διεξοδικές δοκιμές σε όλες τις πλατφόρμες.
** Πόροι/Οδηγίες: Ανατρέξτε στο [MVVMCROSS Documentation] (https://mvvmcross.com/docs) για καθοδήγηση δέσμευσης δεδομένων.
** εκδοχές: @username
** Ετικέτες: Bug, Android
Ακολουθώντας αυτές τις κατευθυντήριες γραμμές, μπορείτε να δημιουργήσετε καλά δομημένα ζητήματα GitHub που ενισχύουν τη συνεργασία και την αποτελεσματικότητα στο πλαίσιο του έργου MVVMCross.
Αναφορές:[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-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md