كيف تجعل رسائل الالتزام رائعة وتجعل فريقك سعيدًا

تعتبر رسائل الالتزام وسيلة مهمة للتواصل بين أعضاء الفريق

أكثر ما يهم في تطوير برامج الفريق هو التواصل. تعتبر رسائل الالتزام وسيلة مهمة للتواصل بين أعضاء الفريق: ماضيه ومستقبله.

عند تحليل الكود أو تصحيح الأخطاء ، لدينا جميعًا أسئلة مثل:

  • لماذا هذا إذا كان هنا؟
  • من نسى تحديث الفرع؟
  • ما هو تأثير هذا التغيير؟
  • كيف يمكن لهذا التغيير إصلاح أو تحسين الكود؟

تحقيقا لهذه الغاية ، يسمح لنا git-blame باكتشاف أي مراجعة كانت آخر مرة لتغيير الملف. لكن مجرد معرفة أن هذا ليس جيدًا بما يكفي. سيكون من المفيد قراءة رسالة الالتزام بالفعل لفهم ما حدث بالفعل هناك.

نحن بحاجة إلى قراءة الرسالة لتجربة القيمة الحقيقية لرسالة الالتزام الجيد ، وأن نكون متحمسين لكتابتها.

بعض أفضل الممارسات

لذلك ، إذا تم إنشاء غالبية التزامات Git حتى الآن بشيء مثل ، git commit -m "9000 — Bug fixes issue"فجرّب هذا المبدأ التوجيهي في المرة القادمة:

لا تستخدم git الالتزام. -m sg& gt; / --message= gt; flag t

يمنحك عقلية سيئة فورًا لأنك ستشعر أنه يجب عليك ملاءمة رسالة الالتزام الخاصة بك في الأمر الطرفي ، ويجعل الالتزام يبدو وكأنه حجة لمرة واحدة أكثر من كونه صفحة في التاريخ.

يجب أن يتكون السطر الأول دائمًا من 50 حرفًا أو أقل ويجب أن يتبعه سطر فارغ.

اكتب صيغة الأمر: "إصلاح الخلل". [ إضافة | إصلاح | إزالة | تحديث | Refactor ] الصياغة المتسقة تجعل من السهل معالجة قائمة الالتزامات ذهنيًا.

72 حرفًا وصفًا أطول ملفوفًا.

غالبًا ما يكون الموضوع في حد ذاته كافياً.عندما لا يكون الأمر كذلك ، أضف سطرًا فارغًا (هذا مهم) متبوعًا بفقرة واحدة أو أكثر ملفوفة بشدة حتى 72 حرفًا.

يجب أن توضح هذه الفقرات:

لماذا هذا التغيير ضروري؟

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

كيف تعالج المشكلة؟

صف ، على مستوى عالٍ ، ما تم فعله لإحداث التغيير. إذا كان التغيير الذي أجريته واضحًا ، فقد تتمكن من حذف معالجة هذا السؤال.

ما الآثار الجانبية لهذا التغيير؟

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

# 50-character subject line## 72-character wrapped longer description. This should answer:## * Why was this change necessary?# * How does it address the problem?# * Are there any side effects?## Include a link to the ticket, if any.

كيف تجعل حياتك أسهل

هناك الكثير لنتذكره ، ولكن يمكنك إعداد قالب رسالة الالتزام باستخدام ملف commit.template

قم بتكوين Git لاستخدام ملف قالب (على سبيل المثال .gitmessage) ، ثم قم بإنشاء ملف القالب باستخدام Vim:

git config --global commit.template ~/.gitmessagevim ~/.gitmessage

عندما نعمل git commitبدون -mعلامة الرسالة ، سيفتح المحرر قالبنا المفيد جاهزًا للعمل:

# [Add/Fix/Remove/Update/Refactor/Document] [summary]# Why is it necessary? (Bug fix, feature, improvements?)-# How does the change address the issue? -# What side effects does this change have?-# Include a link to the ticket, if any.

لم يتم تضمين الأسطر المعلقة في الرسالة النهائية. ما عليك سوى ملء الأسطر الفارغة بالنص والنقاط تحت المطالبات.

بتتبع القضية في جيثب وBitbucket كلا التعرف على الكلمات الرئيسية close، fixو resolveيليه مباشرة القضية أو سحب عدد الطلب.

أعتقد أن Linus سيكون سعيدًا جدًا إذا لم نستخدمه git commit -m "Fix bug"في مستودع عام مرة أخرى :)

يمكنك البحث في سجل git عن رقم إصدار ، على سبيل المثال ، مع git log --grep=JIRA-1234

يمكنك أيضا استخدام الإضافات مثل vim-fugitiveل همة أو git lensل مشاهدة مباراة كود للوصول بسرعة إلى بوابة ارتكاب الرسائل.

خواطر ختامية

يوضح إنشاء التزامات Git النظيفة الكثير عنك وقد يكون طريقة أساسية يتفاعل بها الأشخاص معك عبر المشاريع.

مع القليل من الممارسة ، يمكنك أن تجعل عادات الالتزام الخاصة بك انعكاسًا أفضل لأفضل أعمالك - العمل الذي من الواضح أنه تم إنشاؤه بعناية وفخر.

مستقبلك سوف تشكرك أنت وفريقك على تفكيرك وإسهابك عندما يركضون git blameلمعرفة سبب وجود هذا الشرط.

إذا استمتعت بهذا المقال ، يرجى التصفيق والتوصية والمشاركة.