Lors de la mise en forme d'un problème GitHub pour MVVMCross, les meilleures pratiques peuvent améliorer la clarté, l'efficacité et la collaboration. Voici quelques directives détaillées:
1. Titres descriptifs **
Utilisez une humeur impérative et assurez-vous que le titre est suffisamment descriptif pour transmettre l'objectif du problème. Évitez de terminer les titres avec des périodes. Par exemple, "Fix Bug dans la liaison des données" est plus efficace que "Bug dans la liaison des données" ou "Bogue de liaison des données". [4] [7].2. Présentation claire **
Fournir un aperçu concis du problème en deux lignes ou moins. Cela devrait inclure l'objectif ou le problème principal en cours de résolution. Par exemple, "Ce problème vise à résoudre une erreur de liaison de données, provoquant des plantages d'application sur les appareils Android." [1] [4].3. Dépendance (le cas échéant) **
Si le problème dépend d'une autre question résolue en premier, liez à ce problème. Cela aide à maintenir un flux de travail clair et garantit que les tâches dépendantes sont traitées dans le bon ordre. Par exemple, "ce problème dépend du [lien vers le problème dépendant]." [1].4. Articles d'action **
Format des éléments d'action comme listes de contrôle cliquables. Cela permet de suivre facilement les progrès et d'attribuer des tâches aux membres de l'équipe. Par exemple:- [] Recherchez la cause de l'erreur de liaison des données.
- [] Implémentez un correctif pour le problème identifié.
- [] Testez le correctif sur plusieurs plates-formes. [1] [4].
5. Ressources / instructions **
Incluez des liens vers la documentation ou les ressources pertinents qui peuvent aider à résoudre le problème. Cela peut inclure des tutoriels, une documentation de l'API ou des discussions précédentes liées au problème. Par exemple, "Reportez-vous à [MVVMCross Documentation] (https://mvvmcross.com/docs) pour dire des conseils sur la liaison des données." [1] [2].6. cessionnaires **
Attribuer le problème à un membre spécifique de l'équipe. Cela garantit la responsabilité et la clarté sur qui est responsable de la tâche. Utilisez la fonctionnalité "cessionnaires" dans GitHub pour affecter les utilisateurs. [1].7. Étiquettes **
Appliquez des étiquettes pertinentes pour catégoriser le problème. Cela aide à filtrer et à hiérarchiser les problèmes au sein du projet. Par exemple, les étiquettes peuvent inclure "Bug", "fonctionnalité" ou "amélioration". [1] [2].8. Board de projet **
Assurez-vous que le problème est ajouté à la carte de projet et correctement triée. Cela implique de définir l'état du problème sur la "boîte de glace" si elle n'est pas prête, "Backlog a priorisé" s'il est prêt mais non assisté, et "en cours" une fois attribué. [1].9. jalons **
Utilisez des jalons pour suivre les progrès des groupes de problèmes ou des demandes de traction. Ceci est particulièrement utile pour les projets plus grands ou lors du suivi de plusieurs tâches liées. [1].10. Mises à jour de la documentation et des progrès **
Mettez régulièrement à jour les commentaires du problème avec des progrès ou des modifications. Cela maintient toutes les parties prenantes informées et facilite la résolution de problèmes collaborative. [7].Exemple d'un problème bien formaté
** Titre: Correction d'une erreur de liaison des données sur les appareils Android
** Présentation: ce problème aborde une erreur de liaison de données provoquant des plantages d'application sur les appareils Android.
** Dépendance: dépend du [lien vers la question dépendante].
Articles d'action:
- [] Étude de la cause de l'erreur de liaison des données.
- [] Implémentez un correctif basé sur les résultats.
- [] effectuer des tests approfondis sur les plates-formes.
** Ressources / Instructions: reportez-vous à [MVVMCross Documentation] (https://mvvmcross.com/docs) pour le guidage de liaison des données.
** cessionnaires: @username
** Étiquettes: bug, Android
En suivant ces directives, vous pouvez créer des problèmes de github bien structurés qui améliorent la collaboration et l'efficacité au sein du projet MVVMCross.
Citations:[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://tilburgscienhub.com/topics/automation/version-control/start-git/write-good-issues/
[5] https://github.com/mvvmcross/mvvmcross
[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-tyle-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md