أفضل طرق كتابة رسائل Git Commit: تماماً مثل المحترفين

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

\ هناك معايير لرسائل الالتزام يمارسها المطورون حول العالم، ومن الجيد اتباع المعايير الشائعة حتى عندما تعود بعد فترة طويلة من الوقت أو ينظر شخص آخر إلى رسائل الالتزام الخاصة بك، فلن تبدو مزعجة!

\

\ يجب على الفرق أولاً تحديد اتفاقية رسالة الالتزام التي تحدد تاريخ التحكم في الإصدار للمنتج الذي يقومون ببنائه.

\ يجب أن تحتوي رسالة الالتزام الرائعة في Git على أسلوب ومحتوى وبيانات وصفية مناسبة.

\ يتبع الالتزام المعروف في Git هذه الاتفاقية:

<type>(<scope>): <message>

\ <type> يمكن أن يكون أحد ما يلي:

• feat لميزة جديدة.
• refactor لإعادة هيكلة كود الإنتاج، على سبيل المثال، إعادة تسمية وظيفة.
• docs للتغييرات في الوثائق.
• fix لإصلاح خطأ للمستخدم.
• perf لتحسينات الأداء.
• style لتغييرات التنسيق، والفواصل المنقوطة المفقودة، وما إلى ذلك.
• test لإضافة اختبارات مفقودة، وإعادة هيكلة الاختبارات.
• build لتحديث تكوين البناء، وأدوات التطوير، أو التغييرات الأخرى غير ذات الصلة بالمستخدم.

\ يمكنك أيضًا إضافة نوعك المخصص، أيضًا، اعتمادًا على المعايير التي يتبعها فريقك. يتم اتباع المعايير المذكورة أعلاه من قبل فريق ESLint. يمكنك التحقق من رسائل الالتزام الخاصة بهم هنا.

\ النطاق اختياري، ويجب أن يتضمن جزء الرسالة بيانًا من سطر واحد، لا يزيد عن 72 حرفًا، لتلخيص الغرض من الالتزام.

\ يستخدم العديد من المطورين أيضًا الرسالة كسطر الموضوع ويضيفون نصًا أيضًا؛ وهذا هو أساسًا وصف الالتزام، ولكن رسالة الالتزام ذات السطر الواحد مفضلة طالما يمكنك فهم السياق (ماهية الالتزام ولماذا). إذا كان الالتزام يتطلب وصفًا أكثر تفصيلاً لا يمكن شرحه في سطر واحد، فإن نص الالتزام ضروري دائمًا.

\ يمكنك أيضًا استخدام أدوات مثل Glitter أو Commitizen لتوحيد رسائل الالتزام الخاصة بك.

\ ليس هذا فحسب، بل قد تتساءل أيضًا عما إذا كانت هناك أداة تتحقق من رسالة الالتزام الخاصة بك وتظهر خطأً إذا لم تتبع الإرشادات. Commit lint هي واحدة منها. إنها تساعد فريقك على الالتزام باتفاقية الالتزام.

\ في كثير من الأحيان، يستخدم خبراء الصناعة تذكرة JIRA أو Click Up الخاصة بهم كرسالة التزام بحيث يمكن ربط كل شيء أو تتبعه في أي وقت، ويظل قاعدة الشفرة قابلة للصيانة للمطورين في المستقبل.

\ تحب بعض الفرق أيضًا إضافة الرموز التعبيرية إلى رسائل الالتزام الخاصة بهم. لقد قمت بتجميع قائمة بالرموز التعبيرية ومعانيها المعنية. يمكنك الاطلاع عليها هنا.

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

\ إذا كنت ترغب في معرفة المزيد عن الالتزامات التقليدية، أو الالتزامات الدلالية، أو الممارسات التي تتبعها الصناعة، فإليك بعض الموارد لك:

1. الالتزامات التقليدية
2. الالتزامات الدلالية
3. كيفية كتابة رسالة التزام بواسطة CBeams

\