Saat memformat masalah GitHub untuk MVVMCross, mengikuti praktik terbaik dapat meningkatkan kejelasan, efisiensi, dan kolaborasi. Berikut adalah beberapa pedoman terperinci:
1. Judul Deskriptif **
Gunakan suasana hati yang imperatif dan pastikan judulnya cukup deskriptif untuk menyampaikan tujuan masalah ini. Hindari judul akhir dengan periode. Misalnya, "Perbaiki bug dalam pengikatan data" lebih efektif daripada "bug dalam pengikatan data" atau "bug pengikat data." [4] [7].2. Ikhtisar Bersihkan **
Berikan gambaran singkat tentang masalah ini dalam dua baris atau kurang. Ini harus mencakup tujuan utama atau masalah yang ditangani. Misalnya, "Masalah ini bertujuan untuk menyelesaikan kesalahan pengikatan data yang menyebabkan aplikasi macet pada perangkat Android." [1] [4].3. Ketergantungan (jika berlaku) **
Jika masalah tergantung pada masalah lain yang diselesaikan terlebih dahulu, tautkan ke masalah itu. Ini membantu mempertahankan alur kerja yang jelas dan memastikan bahwa tugas -tugas dependen ditangani dalam urutan yang benar. Misalnya, "masalah ini tergantung pada [tautan ke masalah dependen]." [1].4. Item tindakan **
Format item tindakan sebagai daftar periksa yang dapat diklik. Ini membuatnya mudah untuk melacak kemajuan dan menetapkan tugas kepada anggota tim. Misalnya:- [] Meneliti penyebab kesalahan pengikatan data.
- [] Menerapkan perbaikan untuk masalah yang diidentifikasi.
- [] Uji perbaikan pada beberapa platform. [1] [4].
5. Sumber daya/instruksi **
Sertakan tautan ke dokumentasi atau sumber daya yang relevan yang dapat membantu menyelesaikan masalah ini. Ini mungkin termasuk tutorial, dokumentasi API, atau diskusi sebelumnya yang terkait dengan masalah. Misalnya, "Lihat [Dokumentasi MVVMCross] (https://mvvmcross.com/docs) untuk panduan tentang pengikatan data." [1] [2].6. Penerima
Tetapkan masalah ini ke anggota tim tertentu. Ini memastikan akuntabilitas dan kejelasan tentang siapa yang bertanggung jawab atas tugas tersebut. Gunakan fitur "penugasan" di GitHub untuk menetapkan pengguna. [1].7. Label **
Terapkan label yang relevan untuk mengkategorikan masalah ini. Ini membantu dalam menyaring dan memprioritaskan masalah dalam proyek. Misalnya, label mungkin termasuk "bug," "fitur," atau "peningkatan." [1] [2].8. Papan Proyek **
Pastikan masalah ditambahkan ke dewan proyek dan triaging dengan benar. Ini melibatkan pengaturan status masalah ke "kotak es" jika tidak siap, "prioritaskan backlog" jika siap tetapi tidak ditugaskan, dan "sedang berlangsung" yang pernah ditetapkan. [1].9. Tonggak sejarah **
Gunakan tonggak sejarah untuk melacak kemajuan kelompok masalah atau permintaan tarik. Ini sangat berguna untuk proyek yang lebih besar atau saat melacak beberapa tugas terkait. [1].10. Pembaruan Dokumentasi dan Kemajuan **
Perbarui komentar masalah dengan kemajuan atau perubahan secara teratur. Ini membuat semua pemangku kepentingan mendapat informasi dan memfasilitasi pemecahan masalah kolaboratif. [7].Contoh masalah yang diformat dengan baik
** Judul: Memperbaiki kesalahan pengikatan data pada perangkat Android
** Ikhtisar: Masalah ini membahas kesalahan pengikatan data yang menyebabkan aplikasi macet pada perangkat Android.
** Ketergantungan: Tergantung pada [tautan ke masalah dependen].
Item tindakan:
- [] Selidiki penyebab kesalahan pengikatan data.
- [] Menerapkan perbaikan berdasarkan temuan.
- [] Lakukan pengujian menyeluruh di seluruh platform.
** Sumber Daya/Instruksi: Lihat [Dokumentasi MVVMCross] (https://mvvmcross.com/docs) untuk panduan pengikatan data.
** Penugasan: @UserName
** Label: Bug, Android
Dengan mengikuti pedoman ini, Anda dapat membuat masalah github yang terstruktur dengan baik yang meningkatkan kolaborasi dan efisiensi dalam proyek MVVMCross.
Kutipan:[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://tilburgscienchub.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-pro-prip/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md