MVVMCross için bir GitHub sorunu biçimlendirirken, en iyi uygulamaları takip etmek netliği, verimliliği ve işbirliğini artırabilir. İşte bazı ayrıntılı yönergeler:
1. Açıklayıcı başlıklar **
Zorunlu ruh halini kullanın ve başlığın sorunun amacını iletecek kadar açıklayıcı olduğundan emin olun. Başlıkları dönemlerle bitirmekten kaçının. Örneğin, "Veri Bağlamada Düzeltme", "Veri Bağlamadaki Hata" veya "Veri Bağlama Hatası" dan daha etkilidir. [4] [7].2. Genel Bakış net **
Sorunun iki veya daha az satırı olarak öz bir genel bakış sağlayın. Bu, ele alınan ana hedef veya sorunu içermelidir. Örneğin, "Bu sorun, Android cihazlarda uygulama çökmelerine neden olan bir veri bağlama hatasını çözmeyi amaçlamaktadır." [1] [4].3. Bağımlılık (varsa) **
Sorun önce başka bir sorunun çözülmesine bağlıysa, bu soruna bağlantı. Bu, net bir iş akışının korunmasına yardımcı olur ve bağımlı görevlerin doğru sırada ele alınmasını sağlar. Örneğin, "Bu konu [bağımlı soruna bağlantı] 'ya bağlıdır." [1].4. Eylem öğeleri **
Tıklanabilir kontrol listeleri olarak eylem öğelerini biçimlendirin. Bu, ilerlemeyi izlemeyi ve ekip üyelerine görev atamayı kolaylaştırır. Örneğin:- [] Veri bağlama hatasının nedenini araştırın.
- [] Belirlenen sorun için bir düzeltme uygulayın.
- [] Düzeltmeyi birden çok platformda test edin. [1] [4].
5. Kaynaklar/Talimatlar **
Sorunun çözülmesine yardımcı olabilecek ilgili belgelere veya kaynaklara bağlantılar ekleyin. Bu, öğreticiler, API belgeleri veya sorunla ilgili önceki tartışmaları içerebilir. Örneğin, "Veri bağlama konusunda rehberlik için [MVVMCross belgeleri] (https://mvvmcross.com/docs)." [1] [2].6. Atanan **
Sorunu belirli bir ekip üyesine atayın. Bu, görevden kimin sorumlu olduğu konusunda hesap verebilirlik ve netlik sağlar. Kullanıcıları atamak için GitHub'daki "Atanan" özelliğini kullanın. [1].7. Etiketler **
Sorunu kategorize etmek için ilgili etiketleri uygulayın. Bu, proje içindeki sorunların filtrelenmesine ve önceliklendirilmesine yardımcı olur. Örneğin, etiketler "hata," "özelliği" veya "geliştirme" içerebilir. [1] [2].8. Proje Kurulu **
Proje panosuna sorunun eklendiğinden ve uygun şekilde tetiklendiğinden emin olun. Bu, hazır değilse sorun durumunu "buz kutusu" olarak ayarlamayı içerir, "önceliklendirilmiş biriktirme" ve eğer atanmamışsa ve "devam eden" bir kez atanır. [1].9. Kilometre Taşları **
Sorun gruplarının ilerlemesini veya çekme isteklerini izlemek için kilometre taşlarını kullanın. Bu özellikle daha büyük projeler için veya ilgili birden fazla görevi izlerken yararlıdır. [1].10. Dokümantasyon ve İlerleme Güncellemeleri **
Sorun yorumlarını ilerleme veya değişikliklerle düzenli olarak güncelleyin. Bu, tüm paydaşları bilgilendirir ve işbirlikçi problem çözmeyi kolaylaştırır. [7].İyi biçimlendirilmiş bir sorun örneği
** Başlık: Android cihazlarda veri bağlama hatasını düzeltin
** Genel Bakış: Bu sorun, Android cihazlarda uygulama çökmelerine neden olan bir veri bağlama hatası ele alır.
** Bağımlılık: [Bağımlı soruna bağlantı] 'ya bağlıdır.
Eylem öğeleri:
- [] Veri bağlama hatasının nedenini araştırın.
- [] Bulgulara dayalı bir düzeltme uygulayın.
- [] Platformlar arasında kapsamlı testler yapın.
** Kaynaklar/Talimatlar: Veri bağlama yönlendirmesi için [mvvmcross belgeleri] (https://mvvmcross.com/docs) bkz.
** Atananlar: @username
** Etiketler: Bug, Android
Bu yönergeleri izleyerek, MVVMCross projesinde işbirliğini ve verimliliği artıran iyi yapılandırılmış GitHub sorunları oluşturabilirsiniz.
Alıntılar:[1] https://www.hackforla.org/guide-pages/github-usues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/working-with-vanced-formatting/organizing-information-with tablolar
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-ises/ses/
[5] https://github.com/mvvmcross/mvmcross-smplesples
[6] https://github.com/mvvmcross/mvvmcross-smamples/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/decoln/contributing.md