تساعد Git الفرق المتنوعة والموزعة على العمل على قاعدة بيانات موحدة. مع هذه القوة تأتي المسؤولية: ترك أوصاف جيدة للتغييرات الخاصة بك.
رسائل الالتزام هي أوصاف قصيرة لكل عملية تنفيذ في نظام التحكم في الإصدار مثل Git. عندما تقوم بإجراء تغييرات على ملفات مشروعك ، يجب عليك تقديم رسالة تشرح ما يفعلونه أو سبب إجرائك لهم.
تعمل رسائل الالتزام كشكل من أشكال التوثيق والاتصال. يلعبون دورًا حاسمًا في الحفاظ على تاريخ إصدار واضح ومنظم للمشروع. تعرف على كيفية كتابة رسائل الالتزام الجيدة وسيقدر الأعضاء الآخرون في فريقك عملك بشكل أكبر.
هيكل رسالة الالتزام الجيد
من الأمثلة الجيدة لرسالة الالتزام أربعة أقسام: النوع والوصف والنص والتذييل.
مثل ذلك:
: [نص اختياري]
[تذييل اختياري]
يكتب
يصف النوع نوع التغيير الذي تم إجراؤه في الالتزام الحالي. يمكنك استخدام أي نظام منطقي لظروفك. على سبيل المثال ، إليك بعض نماذج الكلمات الرئيسية التي يمكنك استخدامها للإشارة إلى كل نوع من التغيير ، جنبًا إلى جنب مع مثال الاستخدام:
- عمل: تغييراتك تقدم ميزة جديدة.
- يصلح: يمكنك إصلاح الخلل.
- المعاد تصنيعه: تغيير كود refactors الخاص بك دون إصلاح الخلل أو إضافة ميزة جديدة.
- امتحان: إجراء أي تغييرات متعلقة بالاختبار. على سبيل المثال ، عندما كتابة الاختبارات مع Jest او اي إطار اختبار آخر اختار أنت.
- عمل روتيني: تغييرات غير مرتبطة بإصلاح أو ميزة أو اختبار. على سبيل المثال ، تحديث التبعيات.
- المستندات: عند تحديث الوثائق.
- أسلوب: التغييرات التي لا تؤثر على معنى الكود ، مثل إضافة مسافة بيضاء ، وفقدان الفاصلة المنقوطة ، وما إلى ذلك.
- أداء: التغييرات المتعلقة بتحسينات الأداء.
- يبني: عند إجراء تغييرات تؤثر على ملفات الإنشاء.
- ci: التغييرات المتعلقة بالتكامل المستمر.
- يرجع: عند الرجوع إلى التزام سابق.
وصف
"وصف" رسالة الالتزام هو ملخص موجز ووصفي للتغييرات التي تم إجراؤها في الالتزام. إنه بمثابة عنوان رئيسي يجسد جوهر الالتزام.
عند كتابة الوصف ، ضع في اعتبارك ما يلي:
- اجعل الأمر واضحًا ومحددًا بما يكفي لوصف الالتزام في لمحة.
- اجعلها مختصرة وموجزة. من الناحية المثالية ، سيكون من الأفضل قصره على 50 حرفًا أو أقل.
- اكتبه في المضارع ، حتى لو كنت تصف التغييرات التي تم إجراؤها بالفعل.
- استفد من الحالة المزاجية الحتمية أثناء كتابتها.
- ابدأ بحرف كبير.
- لا تنهيه بفترة.
على سبيل المثال:
العمل الفذ: تنفيذ تبديل الوضع المظلم للصفحة الرئيسية
يوضح هذا المثال كيف يمكنك كتابة وصف الالتزام بذلك ينفذ الوضع المظلم. يستخدم عمل اكتب لأنه يقدم ميزة جديدة.
الجسم (اختياري)
يوفر قسم نص رسالة الالتزام تفاصيل إضافية وسياقًا حول التغييرات التي تم إجراؤها في الالتزام. لن تحتاج دائمًا إلى هيئة ، ولكن يمكن أن تساعد في توفير مزيد من المعلومات ، أو شرح أسباب التغيير ، أو وصف أي اعتبارات فنية.
فيما يلي بعض الأشياء التي يجب ملاحظتها أثناء كتابة قسم النص في رسالة الالتزام:
- لا يقوم Git بتغليف النص تلقائيًا ، لذا قم بلفه يدويًا عند 72 حرفًا عند كتابة النص. يمنح هذا Git مساحة كافية لوضع مسافة بادئة للنص ، مما يجعله أكثر قابلية للقراءة.
- استخدم الجسم لشرح ما حدث في التغيير ، ولماذا أجريت التغيير ، والأسباب الكامنة وراء التغيير.
- تحتاج إلى ترك سطر فارغ بين سطر الوصف والنص. هذا يسمح لـ Git بالتمييز بينهما.
- إذا أدخل الالتزام تغييرات متعددة أو أثر على مناطق مختلفة من قاعدة الشفرة ، ففكر في استخدام النقاط أو الفقرات لتقسيم التعديلات. هذا يحسن القراءة ويساعد القراء على فهم الجوانب المختلفة للالتزام.
على سبيل المثال:
العمل الفذ: إضافة GitHub كموفر OAuthادمج GitHub كموفر OAuth للتمكين بسلاسة
المصادقة مع حسابات جيثب.
- تنفيذ تدفق مصادقة OAuth باستخدام واجهة برمجة تطبيقات GitHub
- تكوين نقاط النهاية والإعدادات الضرورية لمصادقة GitHub
- تحديث واجهة المستخدم لتشمل خيار تسجيل الدخول إلى GitHub
يوضح المثال أعلاه رسالة Git الالتزام الجيدة لميزة تضيف GitHub كموفر OAuth لتطبيقك. تحتوي رسالة الالتزام هذه على سطر ملخص موجز (50 حرفًا أو أقل) ، ونصًا توضيحيًا أكثر تفصيلاً (ملفوفًا بحوالي 72 حرفًا) ، ونقاطًا نقطية للحصول على معلومات إضافية.
يعد قسم التذييل في رسالة الالتزام جزءًا اختياريًا يوفر معلومات إضافية أو بيانات وصفية متعلقة بالالتزام. يتم وضعه عادةً بعد قسم الجسم ، مفصولاً بخط فارغ. يمكن أن يتضمن التذييل أنواعًا مختلفة من المعلومات ، مثل مراجع المشكلات ذات الصلة أو العلامات أو الملاحظات الخاصة.
عند الإشارة إلى المشكلات أو طلبات السحب أو العناصر الأخرى ذات الصلة ، استخدم الصيغة أو التنسيق المناسب الذي يتطلبه نظام تتبع المشكلات في مشروعك. هذا يضمن التعرف على المراجع وربطها بشكل صحيح.
على سبيل المثال:
إنجاز: إضافة GitHub كموفر OAuthادمج GitHub كموفر OAuth للتمكين بسلاسة
المصادقة مع حسابات جيثب.- تنفيذ تدفق مصادقة OAuth باستخدام واجهة برمجة تطبيقات GitHub
- تكوين نقاط النهاية والإعدادات الضرورية لمصادقة GitHub
- تحديث واجهة المستخدم لتشمل خيار تسجيل الدخول إلى GitHub
يقرر: # 123
أنظر أيضا: # 456 ، # 789
يشير التذييل إلى المشكلة ذات الصلة # 123 ويذكر المشكلات الأخرى ذات الصلة # 456 و # 789 لسياق إضافي.
إضافة رسالة الالتزام
يمكنك كتابة الرسائل باستخدام ملف م علامة متبوعة برسالة الالتزام المضمنة بين علامتي اقتباس (اختياري ولكن موصى به).
ال م تعتبر العلامة مثالية لرسائل الالتزام القصيرة ، وعادةً ما تتضمن النوع والوصف.
على سبيل المثال:
git الالتزام -m "عمل روتيني: تغيير linter إلى ESlint"
ومع ذلك ، عندما تتطلب رسالة الالتزام مزيدًا من التفاصيل ، مثل نص وتذييل ، فمن الأفضل لك كتابة الالتزام في محرر نصي أو IDE.
بدلاً من ذلك ، يمكنك كتابة رسائل طويلة في ملف نصي واستخدام ملحق --ملف علامة لتحديد رسائل الالتزام كمحتويات الملف النصي.
على سبيل المثال:
git الالتزام - ملف الالتزام_المراسلة. txt
عند تشغيل الأمر أعلاه ، سيستخدم git محتويات الملف كرسالة التنفيذ.
يمكنك أيضًا إخبار git بفتح المحرر الافتراضي لكتابة رسالة أطول. إذا كانت لديك مجموعة متغير البيئة GIT_EDITOR أو EDITOR ، فسيفتح git هذا البرنامج عندما تقوم بتشغيل مكشوف بوابة الالتزام يأمر.
لماذا يجب عليك كتابة رسائل الالتزام الجيد
تعد كتابة رسائل الالتزام الجيدة أمرًا بالغ الأهمية للتعاون الفعال وصيانة التعليمات البرمجية. تساعد الرسائل الواضحة والوصفية على فهم وتصحيح الأخطاء ومراجعات التعليمات البرمجية. يمكنهم حتى المساهمة في وثائق المشروع أو ملاحظات الإصدار.
أنها تمكن من مشاركة المعرفة ، والإعداد السلس ، ودعم التحكم في الإصدار. يؤدي تحديد أولويات رسائل الالتزام بالجودة إلى تحسين عمليات التطوير ويضمن إمكانية صيانة قاعدة التعليمات البرمجية.
