Home Arrow Icon Knowledge base Arrow Icon Global Arrow Icon Mvvmcross belgesine nasıl katkıda bulunabilirim


Mvvmcross belgesine nasıl katkıda bulunabilirim


MVVMCross belgelerine katkıda bulunmak, çerçeveyi geliştirmeye ve diğer geliştiricilere yardımcı olmak için değerli bir yoldur. İşte nasıl katkıda bulunabileceğinize dair adım adım bir kılavuz:

1. Dokümantasyon yapısını anlayın **

MVVMcross, belgeleri için Jekyll'i kullanır, yani her sayfa YAML ön madde gerektirir. Bu, sayfanın düzenini, başlığını ve kategorisini belirtmeyi içerir. Bir blog yayınını düzenlemediğiniz sürece, düzen genellikle "belgeler" olarak ayarlanır. Kategoriler yeniden kullanılmalı ve menüde mevcut olanlarla tutarlı bir şekilde adlandırılmalıdır [2].

2. Markdown'a aşina olun **

Belgeler GitHub ile aynı Markdown sözdizimini kullanır. Biçimlendirme yönergeleri için GitHub'ın işaretleme referansına başvurabilirsiniz. Bu, belge sayfalarınıza göreceli bağlantıların ve görüntülerin nasıl ekleneceğini içerir [2].

3. Jekyll'i yerel olarak ayarlama **

Daha büyük değişiklikler için, Jekyll ile yerel olarak MVVMCross GitHub sayfaları sitesini kurmak faydalıdır. Bu, göndermeden önce değişikliklerinizi önizlemenizi sağlar. Jekyll'i yüklemeniz ve yerel olarak bir GitHub sayfa sitesi oluşturmak için GitHub'ın talimatlarını izlemeniz gerekir [2].

4. Katkı Yönergeleri **

- Başlıklar ve cümleler: Kısa ve özlü tutun. Başlıklar ideal olarak üç veya dört kelime uzunluğunda olmalıdır.
- Kronolojik Düzen: Konuları mantıklı bir sırayla tanımlayın.
- Konuda kalın: Ana konudan sapmaktan kaçının.
- Dilbilgisi ve noktalama işaretleri: Dilbilgisi ve noktalama işaretlerinin doğru kullanımını sağlayın.
- Yazım denetleyicisi: Hataları en aza indirmek için bir yazım denetleyicisi kullanın [2].

5. Katkılarınızı gönderin **

Katkılar genellikle GitHub çekme istekleri ile yapılır. Mevcut sayfaları düzenleyebilir veya yenilerini oluşturabilirsiniz. Nasıl ilerleyeceğinizden emin değilseniz, GitHub sorunları veya diğer destek kanalları aracılığıyla değişiklik önererek veya ekiple tartışarak başlayabilirsiniz [1] [5].

6. Toplulukla etkileşime geçin **

Belgelere katkıda bulunmanın yanı sıra, deneyimlerinizi MVVMCross ile paylaşarak, hatalar sunarak veya tartışmalara katılarak da yardımcı olabilirsiniz. Bu geri bildirim, çerçeveyi geliştirmek için paha biçilmezdir [1].

7. İnceleme Süreci **

Dokümantasyon stili ve kalite standartlarıyla uyumlu olduklarından emin olmak için katkılarınız gözden geçirilecektir. Bu süreç belgeler boyunca tutarlılığın korunmasına yardımcı olur [2].

Bu adımları izleyerek, MVVMCross belgelerine etkili bir şekilde katkıda bulunabilir ve topluluğun çerçeveyi anlamasını ve kullanımını geliştirmeye yardımcı olabilirsiniz.

Alıntılar:
[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/decoln/contributing.md
[4] https://www.mvvmcross.com/documentation/adved/customizing-using-app-and-setup
[5] https://www.mvvmcross.com/documentation/
[6] https://github.com/mapsui/mapsui/issues/747
[7] https://www.mvvmcross.com/documentation/getting-started/mvvmcross-overview
[8] https://stackoverflow.com/questions/51552868/mvvmcross-complete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundament/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross