يحتوي هذا المستند على تعليمات حول إنشاء ملاحظات الإصدار الخاصة بـ "استوديو Android".
الهدف
لإنشاء ملاحظات إصدار مفصّلة لعمليات الدمج من مستودع GitHub
التعليمات
يُرجى اتّباع هذه التعليمات بالتسلسل وبشكل كامل.
الخطوة 1: استنساخ المستودع أو تعديله
ابحث عن مجلد studio-main في هذا المشروع. إذا لم يكن هناك ملف، استنسِخ مستودع studio-main باستخدام الأمر التالي:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
إذا كان الدليل متوفّرًا، أعِد تحميله من خلال سحب محتوى المستودع من GitHub.
يُرجى إعلامي بحالة studio-main قبل المتابعة.
الخطوة 2: دراسة المستودع
دراسة محتوى المستودع
الخطوة 3: الحصول على عمليات الدمج
احصل على جميع عمليات الإيداع التي تم إرسالها إلى مستودع studio-main خلال الإطار الزمني الذي قدّمته لك. يُرجى إخباري بالعدد قبل المتابعة. استخدِم الأمر wc -l دائمًا لإجراء عمليات العد.
تحديد عمليات الدمج المستهدَفة: من سجلّ git، استخرِج كتلة الدمج الكاملة لكل عملية دمج تحتوي على السلسلة النصية "Relnote:
" حيث هو اسم المنتج الذي قدّمته. إذا لم أقدّم اسم منتج، ابحث فقط عن "Relnote". يتضمّن "حزمة التعديل" تجزئة التعديل والمؤلف والتاريخ ورسالة التعديل الكاملة واختلاف الرمز.
استخدِم الأداة الصحيحة: لفلترة عمليات الإيداع حسب النطاق الزمني واسم المنتج، استخدِم الأمر التالي:
git log --after="
" --before=" " --grep="Relnote: " حيث
و هما النطاق الزمني الذي قدّمته لك، و هو اسم المنتج الذي قدّمته لك. إذا لم يتم تقديم اسم منتج، ما عليك سوى استخدام الأمر التالي:
git log --after="
" --before=" " --grep="Relnote" تأكيد العدد: أريد الاطّلاع على العدد الإجمالي وعمليات التجزئة وعناوين جميع عمليات الدمج التي حدّدتها. سأرسل إليك تأكيدًا للمتابعة.
الخطوة 4: إنشاء ملاحظات تفصيلية حول الإصدار
تحليل كل عملية إيداع: لكل عملية إيداع حدّدتها في الخطوة السابقة، عليك إجراء تحليل تفصيلي يتضمّن ما يلي:
- قراءة رسالة الالتزام الكاملة
- فحص الفرق في الرمز (git show
) لفهم التغيير - متابعة أي أخطاء مرتبطة (على سبيل المثال، الخطأ: 12345678) لجمع المزيد من السياق
يُرجى التأكيد معي قبل المتابعة.
تحليل أي مستندات ذات صلة في مجلد المستندات للحصول على معلومات ذات صلة بعمليات الإيداع استخدِم هذه المعلومات لإنشاء ملاحظة إصدار غنية بالمحتوى.
يُرجى إخباري عن عمليات الدمج التي تتضمّن معلومات ذات صلة في مجلد المستندات قبل المتابعة.
الحصول على أي أخطاء تمت الإشارة إليها في عمليات الإيداع استخدِم المعلومات الواردة في الخطأ للمساعدة في إنشاء ملاحظات الإصدار الخاصة بعملية الدمج.
كتابة ملاحظات الإصدار: لكل عملية إيداع، اكتب ملاحظات إصدار تتضمّن ما يلي:
مرجع عملية الإيداع: أضِف قبل كل ملاحظة إصدار تعليق Markdown يحتوي على رمز التجزئة لعملية الإيداع المصدر، على النحو التالي: .
عنوان واضح: ملخّص موجز للتغيير مكتوب بأحرف كبيرة وصغيرة
تفسير مفصّل: فقرة تشرح طبيعة التغيير.
في ما يلي النقاط الرئيسية حول التغيير بالترتيب التالي:
أ- السبب: التغييرات التي تم إجراؤها وسببها ب. التأثير: التأثير على مطوّري التطبيقات c. نقل البيانات: مسار نقل البيانات (إن وُجد)
أمثلة على الرمز البرمجي "قبل" و "بعد": إذا كان الالتزام يتضمّن تغييرًا في الرمز البرمجي يواجهه المستخدم (على سبيل المثال، تغييرات في لغة خاصة بالمجال في ملفات .gradle أو تعديلات على واجهة برمجة التطبيقات)، قدِّم مقتطفات واضحة وموجزة من الرمز البرمجي توضّح التغيير.
اتّبِع نمط ملاحظات الإصدار على https://developer.android.com/studio/releases.
الخطوة 5: كتابة ملاحظات الإصدار في ملف Markdown
- أنشئ ملف Markdown باسم release-notes-YYYY-MM-DDTHH:MM.md في جذر المشروع، حيث يمثل YYYY-MM-DD (السنة-الشهر-اليوم) التاريخ الحالي بتنسيق ISO 8601، ويمثل T الفاصل، ويمثل HH:MM (الساعات:الدقائق بتنسيق 24 ساعة) الوقت الحالي.
- اكتب مقدمة تشرح الغرض من ملاحظات الإصدار.
- اكتب ملخّصًا لملاحظات الإصدار.
- اكتب ملاحظات الإصدار الكاملة والمنسّقة.
الخطوة 6: إنشاء عملية إيداع
أنشئ عملية إيداع في Fig لملف ملاحظات الإصدار. لا تُدرِج معرّف خطأ.
الخطوة 7: إنشاء قائمة تغييرات
أنشئ قائمة تغييرات لعملية الإيداع.