Berkontribusi pada dokumentasi MVVMCross adalah cara yang berharga untuk membantu meningkatkan kerangka kerja dan membantu pengembang lain. Berikut panduan langkah demi langkah tentang bagaimana Anda dapat berkontribusi:
1. Memahami struktur dokumentasi **
MVVMCross menggunakan Jekyll untuk dokumentasinya, yang berarti setiap halaman membutuhkan materi depan YAML. Ini termasuk menentukan tata letak, judul, dan kategori untuk halaman. Tata letak biasanya diatur ke "dokumentasi" kecuali Anda mengedit posting blog. Kategori harus digunakan kembali dan dinamai secara konsisten dengan yang sudah ada di menu [2].2. Biasakan diri Anda dengan penurunan harga **
Dokumentasi menggunakan sintaks penurunan harga yang sama dengan GitHub. Anda dapat merujuk pada referensi penurunan harga GitHub untuk memformat pedoman. Ini termasuk cara menambahkan tautan dan gambar relatif ke halaman dokumentasi Anda [2].3. Menyiapkan Jekyll secara lokal **
Untuk perubahan yang lebih besar, bermanfaat untuk mengatur situs halaman MVVMCross GitHub secara lokal dengan Jekyll. Ini memungkinkan Anda untuk mempratinjau perubahan Anda sebelum mengirimkannya. Anda harus menginstal Jekyll dan mengikuti instruksi GitHub untuk menyiapkan situs halaman GitHub secara lokal [2].4. Pedoman Kontribusi **
- Judul dan Kalimat: Jaga agar singkat dan ringkas. Judul idealnya panjangnya tiga atau empat kata.- Urutan kronologis: Jelaskan topik dalam urutan logis.
- Tetap di Topik: Hindari menyimpang dari subjek utama.
- Tata bahasa dan tanda baca: Pastikan penggunaan tata bahasa dan tanda baca yang tepat.
- Pemeriksa ejaan: Gunakan pemeriksa ejaan untuk meminimalkan kesalahan [2].
5. Kirim kontribusi Anda **
Kontribusi biasanya dilakukan melalui permintaan tarik GitHub. Anda dapat mengedit halaman yang ada atau membuat yang baru. Jika Anda tidak yakin tentang cara melanjutkan, Anda dapat mulai dengan menyarankan perubahan atau mendiskusikannya dengan tim melalui masalah GitHub atau saluran dukungan lainnya [1] [5].6. Terlibat dengan komunitas **
Selain dokumentasi yang berkontribusi, Anda juga dapat membantu dengan berbagi pengalaman Anda dengan MVVMCross, mengajukan bug, atau berpartisipasi dalam diskusi. Umpan balik ini sangat berharga untuk meningkatkan kerangka kerja [1].7. Proses tinjauan **
Kontribusi Anda akan ditinjau untuk memastikan mereka selaras dengan gaya dokumentasi dan standar kualitas. Proses ini membantu menjaga konsistensi di seluruh dokumentasi [2].Dengan mengikuti langkah -langkah ini, Anda dapat secara efektif berkontribusi pada dokumentasi MVVMCross dan membantu meningkatkan pemahaman dan penggunaan kerangka kerja masyarakat.
Kutipan:[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/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/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/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross