تعد المساهمة في وثائق MVVMCROSS طريقة قيمة للمساعدة في تحسين الإطار ومساعدة المطورين الآخرين. إليك دليل خطوة بخطوة حول كيفية المساهمة:
1. فهم بنية الوثائق **
يستخدم MVVMCROSS JEKYLL لتوثيقه ، مما يعني أن كل صفحة تتطلب مسألة أمامية YAML. يتضمن ذلك تحديد التصميم والعنوان والفئة للصفحة. عادة ما يتم تعيين التصميم على "الوثائق" ما لم تقم بتحرير منشور مدونة. يجب إعادة استخدام الفئات وتسميتها باستمرار مع الفئات الموجودة في القائمة [2].2. تعرف على Markdown **
يستخدم الوثائق نفس بناء جملة Markdown مثل Github. يمكنك الرجوع إلى مرجع تخفيض Github لتنسيق المبادئ التوجيهية. يتضمن ذلك كيفية إضافة الروابط والصور النسبية إلى صفحات الوثائق الخاصة بك [2].3. إعداد Jekyll محليًا **
من أجل التغييرات الأكبر ، من المفيد إعداد موقع صفحات Github MVVMCROSS محليًا مع Jekyll. يتيح لك ذلك معاينة التغييرات الخاصة بك قبل إرسالها. ستحتاج إلى تثبيت Jekyll ومتابعة تعليمات Github لإعداد موقع GitHub Pages محليًا [2].4. إرشادات المساهمة **
- العناوين والجمل: احتفظ بها قصيرة وموجزة. يجب أن تكون العناوين ثلاث كلمات أو أربع كلمات.- الترتيب الزمني: وصف الموضوعات في تسلسل منطقي.
- البقاء في الموضوع: تجنب الابتعاد من الموضوع الرئيسي.
- القواعد النحوية وعلامات الترقيم: ضمان الاستخدام السليم للقواعد وعلامات الترقيم.
- مدقق الإملاء: استخدم مدقق إملائي لتقليل الأخطاء [2].
5. أرسل مساهماتك **
عادة ما يتم تقديم المساهمات من خلال طلبات سحب github. يمكنك تحرير الصفحات الحالية أو إنشاء صفحات جديدة. إذا كنت غير متأكد من كيفية المتابعة ، فيمكنك البدء باقتراح التغييرات أو مناقشتها مع الفريق عبر مشكلات Github أو قنوات الدعم الأخرى [1] [5].6. التعامل مع المجتمع **
إلى جانب الوثائق المساهمة ، يمكنك أيضًا المساعدة من خلال مشاركة تجاربك مع MVVMcross ، أو تقديم الأخطاء ، أو المشاركة في المناقشات. هذه التعليقات لا تقدر بثمن لتحسين الإطار [1].7. عملية المراجعة **
ستتم مراجعة مساهماتك للتأكد من أنها تتماشى مع أسلوب الوثائق ومعايير الجودة. تساعد هذه العملية في الحفاظ على الاتساق عبر الوثائق [2].باتباع هذه الخطوات ، يمكنك المساهمة بفعالية في وثائق MVVMCROSS والمساعدة في تعزيز فهم المجتمع واستخدامه للإطار.
الاستشهادات:[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