عند تنسيق مشكلة github لـ MVVMCross ، يمكن أن يعزز أفضل الممارسات الوضوح والكفاءة والتعاون. فيما يلي بعض الإرشادات التفصيلية:
1. العناوين الوصفية **
استخدم الحالة المزاجية الضرورية وضمان أن يكون العنوان وصفيًا بما يكفي لنقل الغرض من القضية. تجنب إنهاء العناوين بفترات. على سبيل المثال ، يكون "إصلاح الخلل في ربط البيانات" أكثر فعالية من "الأخطاء في ربط البيانات" أو "خطأ ربط البيانات". [4] [7].2.
تقديم نظرة عامة موجزة على المشكلة في سطرين أو أقل. يجب أن يشمل ذلك الهدف الرئيسي أو المشكلة التي يتم معالجتها. على سبيل المثال ، "تهدف هذه المشكلة إلى حل خطأ ربط البيانات الذي يتسبب في تعطل التطبيق على أجهزة Android." [1] [4].3. التبعية (إن أمكن) **
إذا كانت المشكلة تعتمد على حل مشكلة أخرى يتم حلها أولاً ، اربط بهذه القضية. يساعد هذا في الحفاظ على سير عمل واضح ويضمن معالجة المهام المعتمدة بالترتيب الصحيح. على سبيل المثال ، "هذه المشكلة تعتمد على [رابط إلى القضية التابعة]." [1].4. عناصر العمل **
تنسيق عناصر الإجراء كقوائم مراجعة قابلة للنقر. هذا يجعل من السهل تتبع التقدم وتعيين المهام لأعضاء الفريق. على سبيل المثال:- [] البحث عن سبب خطأ ربط البيانات.
- [] تنفيذ إصلاح للقضية المحددة.
- [] اختبر الإصلاح على منصات متعددة. [1] [4].
5. الموارد/التعليمات **
قم بتضمين روابط إلى الوثائق أو الموارد ذات الصلة التي يمكن أن تساعد في حل المشكلة. قد يشمل ذلك دروسًا أو وثائق API أو المناقشات السابقة المتعلقة بالمشكلة. على سبيل المثال ، "الرجوع إلى [وثائق MVVMCROSS] (https://mvvmcross.com/docs) للتوجيه على ربط البيانات." [1] [2].6.
تعيين القضية لعضو فريق معين. هذا يضمن المساءلة والوضوح على من المسؤول عن المهمة. استخدم ميزة "المحالبين" في GitHub لتعيين المستخدمين. [1].7. العلامات **
تطبيق الملصقات ذات الصلة لتصنيف المشكلة. هذا يساعد في تصفية القضايا وتحديد أولوياتها في المشروع. على سبيل المثال ، قد تتضمن الملصقات "BUG أو" ميزة "أو" تحسين ". [1] [2].8. لوحة المشروع **
تأكد من إضافة المشكلة إلى لوحة المشروع والثلاثي بشكل صحيح. يتضمن ذلك تعيين حالة المشكلة على "مربع ICE" إذا لم يكن جاهزًا ، "أعطى الأولويات" إذا كان جاهزًا ولكنه غير معروف ، و "قيد التقدم" بمجرد تعيينه. [1].9. المعالم البارزة **
استخدم المعالم لتتبع تقدم مجموعات القضايا أو طلبات السحب. هذا مفيد بشكل خاص للمشاريع الكبيرة أو عند تتبع مهام متعددة ذات صلة. [1].10. تحديثات الوثائق والتقدم **
قم بتحديث المشكلة بانتظام مع التقدم أو التغييرات. هذا يبقي جميع أصحاب المصلحة على اطلاع ويسهل حل المشكلات التعاونية. [7].مثال على مشكلة جيدة التنسيق
** العنوان: إصلاح خطأ ربط البيانات على أجهزة Android
** نظرة عامة: تتناول هذه المشكلة خطأ ربط البيانات الذي يتسبب في تعطل التطبيق على أجهزة Android.
** التبعية: يعتمد على [رابط إلى القضية التابعة].
عناصر الإجراء:
- [] التحقيق في سبب خطأ ربط البيانات.
- [] تنفيذ إصلاح بناءً على النتائج.
- [] إجراء اختبار شامل عبر المنصات.
** الموارد/الإرشادات: راجع [وثائق MVVMCross] (https://mvvmcross.com/docs) للحصول على إرشادات ربط البيانات.
** المعينين: username
** التسميات: علة ، Android
باتباع هذه الإرشادات ، يمكنك إنشاء مشكلات جيثب جيدة التنظيم تعزز التعاون والكفاءة في مشروع MVVMCROSS.
الاستشهادات:[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://tilburgsciencehub.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]
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md