كيف تكتب الرسائل المناسبة

بوابة ارتكبت تغييرات السجلات إلى مستودع.

يتم تنفيذ التزام بوابة في سياق مشروع لتسجيل التقدم. ثم يتم دفع هذا التقدم إلى مستودع بعيد (مثل على github.com) عن طريق تنفيذ دفعة git. قد تعني هذه التغييرات أو التقدم أي إضافات أو عمليات حذف أو تحديثات للملفات المخزنة في المستودع.

نظرة عامة على التزام Git السليم

الائتمان: Imgur

أسرع طريقة لكتابة التزام git هي استخدام الأمر git الالتزام -m "رسالة التزام Git هنا". ومع ذلك ، لا يُنصح باستخدام هذا الإجراء لأنه يوفر وصفًا محدودًا لما تم تغييره. بشكل أساسي ، يجب أن يوضح التزام git سبب التغيير ولماذا.

هنا هو المبدأ التوجيهي لكتابة التزام بوابة كاملة.

  • موضوع يحتوي على عنوان بوابة الالتزام. يجب أن يقتصر هذا على 50 حرفًا ويجب فصله عن بقية الالتزام بخط فارغ.
  • نص توضيحي يوضح ما تم تغييره ولماذا كان التغيير ضروريًا. اكتب المزاج الحتمي مثل "إصلاح الأخطاء التي تسبب انقطاع" بدلاً من "إصلاح الأخطاء التي تسبب انقطاع".

انظر أدناه للحصول على مثال لتنفيذ ما سبق.

رسملة ، ملخص قصير (50 حرفًا أو أقل)
نص توضيحي أكثر تفصيلا ، إذا لزم الأمر. لفه إلى حوالي 72
الشخصيات أو نحو ذلك. في بعض السياقات ، يعامل السطر الأول كـ
موضوع رسالة بريد إلكتروني وبقية النص كجسم. الفراغ
الخط الفاصل بين الملخص عن الجسم أمر بالغ الأهمية (إلا إذا حذفت
الجسم تماما) ؛ أدوات مثل rebase يمكن الحصول على الخلط إذا قمت بتشغيل
اثنين معا.
اكتب رسالة الالتزام في الضرورة: "Fix bug" وليس "Bug bug"
 أو "إصلاح الخلل". تطابق هذه الاتفاقية مع رسائل الالتزام التي تم إنشاؤها
بواسطة أوامر مثل بوابة جيت والعودة بوابة.
تأتي فقرات أخرى بعد خطوط فارغة.
- نقاط رصاصة على ما يرام ، أيضا
- عادةً ما يتم استخدام الواصلة أو العلامة النجمية للرصاصة ، متبوعة بمسافة واحدة ، مع وجود خطوط فارغة بين ، ولكن الاصطلاحات تختلف هنا
- استخدم مسافة بادئة معلقة

المصدر: تيم البابا

كتابة التزام سليم

  • لكتابة التزام git ، ابدأ بكتابة git الالتزام على طرفك أو موجه الأوامر الذي يعرض واجهة Vim لإدخال رسالة الالتزام.
  • اكتب موضوع التزامك في السطر الأول. تذكر أن تجعلها قصيرة (لا تزيد عن 50 حرفًا). ترك خط فارغ بعد.
  • اكتب وصفًا تفصيليًا لما حدث في التغيير الملتزم. استخدم فقرات ونقاط متعددة لإعطاء تفاصيل تفصيلية. لا تكتب كل شيء في سطر واحد ، بدلاً من ذلك ، لف النص بـ 72 حرفًا.
  • اضغط على Esc ، ثم اكتب: wq للحفظ والخروج.
اكتب رسالة الالتزام في الضرورة: "إصلاح الخلل" وليس "الخلل الثابت" أو "إصلاح الخلل". تتوافق هذه الاتفاقية مع رسائل الالتزام التي تم إنشاؤها بواسطة أوامر مثل git merge و git revert.

يجب أن تجيب رسالة الالتزام على ثلاثة أسئلة أساسية ؛

  • لماذا هذا التغيير ضروري؟
  • كيف يعالج هذا الالتزام المشكلة؟
  • ما الآثار التي يحدثها هذا التغيير؟
الائتمان: xkcd

يعد سجل البوابة الصحيح والمكتوب جيدًا مؤشرًا مهمًا لمدى تفكير المشروع.

سوف تجعل رسائل الالتزام الصحيحة من السهل فهم سبب إجراء تغيير في وقت معين. مع هذا ، سيكون بمقدور المشرفين على المشروع إجراء تغييرات بسهولة بعد مرور عقود لأنهم يفهمون الكود.

ترميز سعيد!