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