رسائل الإتمام
تسهّل رسائل الالتزام الواضحة مراجعة طلبات السحب، كما تسهّل إنشاء ملاحظات الإصدار. يستخدم مشروع Blockly عمليات الالتزام التقليدية للمساعدة في ذلك.
يجب أن يكون لكل عملية إيداع التنسيق التالي:
<type>: <description>
[optional body]
[optional footer(s)]
يُرجى العِلم أنّ مستودع Blockly الأساسي يتضمّن أداة تدقيق للالتزام بهذا الشرط. إذا كان طلب السحب يتضمّن عمليات دمج متعددة، سيتحقّق المدقّق من العنوان. إذا كان يحتوي على عملية دمج واحدة، سيتم التحقّق من عملية الدمج هذه. من الأفضل أن تتوافق كل من عمليات الدمج الفردية وعنوان طلب السحب مع هذه الإرشادات.
النوع
يجب ألا يكون النوع فارغًا، ويجب أن يكون مكتوبًا بأحرف صغيرة. في ما يلي قائمة بالأنواع المقبولة.
chore- لعمليات الإيداع التي تُكمل مهام روتينية أو مبرمَجة، مثل ترقية التبعيات
deprecate- بالنسبة إلى عمليات الدمج التي توقف وظائف معيّنة
feat- لعمليات الدمج التي تضيف وظائف جديدة إلى Blockly
fix- لعمليات الدمج التي تحلّ الأخطاء في Blockly
release- لعمليات الإيداع التي تتعلّق بإصدار نسخة جديدة
التغييرات التي قد تؤدي إلى أعطال
يجب أن تضيف عمليات الإيداع التي تُجري تغييرات غير متوافقة ! بعد نوع عملية الإيداع. التغييرات غير المتوافقة هي تغييرات قد تؤدي إلى تعطُّل التطبيقات التي يستخدم فيها المطوّرون Blockly، ما يضطرهم إلى بذل جهد إضافي.
على سبيل المثال:
none
fix!: return type of workspace.paste
يمكن أن تكون التغييرات غير المتوافقة من أي من الأنواع الصالحة المذكورة أعلاه.
الوصف
يجب أن يكون الوصف غير فارغ وألا يتجاوز 256 حرفًا.
النص
النص اختياري. إذا تم توفيرها، يجب أن يكون هناك سطر فارغ بينها وبين الوصف. يجب تقسيمها إلى أسطر لا يزيد عدد أحرفها عن 256 حرفًا.
يُرجى العِلم أنّه يُنصح عادةً بوضع هذا النوع من المعلومات في وصف طلب السحب، بالإضافة إلى/بدلاً من وضعه مباشرةً في عملية الإيداع.
التذييل
التذييل اختياري. في حال توفّره، يجب أن يكون هناك سطر فارغ بينه وبين النص الأساسي. يجب تقسيمها إلى أسطر لا يزيد عدد أحرفها عن 256 حرفًا.
إصلاح عمليات الدمج غير التقليدية
إذا لم تستخدِم عمليات الالتزام التقليدية عند إجراء التعديلات، يتوفّر خياران لإصلاح الرسائل استنادًا إلى عدد عمليات الالتزام التي أجريتها:
إذا كان طلب السحب يتضمّن عمليات تثبيت متعددة، عدِّل عنوان طلب السحب ليتوافق مع المتطلبات. عند دمج طلب السحب، سيتم دمج عمليات الإيداع الأخرى، ليصبح العنوان رسالة الإيداع.
إذا كان طلب السحب يتضمّن عملية دمج واحدة، عدِّل رسالة عملية الدمج باستخدام
git commit --amend، ثمّ أرسِل التغييرات إلى نسخة Blockly المتفرّعة. سيؤدي ذلك إلى تحديث أي طلبات سحب مفتوحة مرتبطة بهذا الفرع تلقائيًا.git push --force origin my-branch.