٢٠٢٤-١٠-٠٥ ١٣:٤٨
الحالة:
العلامات: البرمجة
في هذا الدرس سنصف اهمية كتابة رسالة التزام بالطريقة الصحيحة الواضحة ليسهل لنا ولغيرنا تصحيح الاخطاء الواقعة مستقبلا, ويمكن تعريف رسائل الالتزام بانها الملاحظات المدرجة مع كل تغيير يحدث في برامجنا, لماذا فعلنا هذه الجزئية بتحديثنا الاخير و على هذا النمط يكون شرحنا للتغيرات التي فعلناها.
وجود رسائل التزام احترافية يعزز من صورتك كمطور محترف ويميزك عن اقرانك في مستوى المطورين المبتدئين.
وجود سجل موثق برسائل التزام احترافية يمكنك لاحقا من الشرح لنفسك ولغيرك مستقبلا لماذا فعلت هذا وكيف فعلتها مما يسهل عملية تصحيح الاخطاء مستقبلا.
وجود سجل التزام مكتوب باحترافية يساعدك على تذكر طريقة ونهج تفكيرك في المستقبل, وهذا مهم جدا للمشاريع الجانبية التي سنعود اليها مستقبلا.
وكما ذكرنا فإن رسالة التزام احترافية تكون واضحة الحل والسبب, يكون لها عنوان مختصر, ونفصل بين العنوان والنص بسطر فارغ ليسهل القراءة, ثم نكتب بعض التفاصيل التي تخص السبب مع مراعاة ان قيت هب لا يقبل اكثر من 72 حرف بالرسالة الواحدة.
القواعد السبعة لكتابة رسالة التزام رائعة!
1. فصل العنوان عن النص بسطر فارغ
قد تظنه شيء بديهيا لتحسين الرؤية وسهولة القراءة, ليس هذا فحسب بل هناك العديد من الخصائص في قيت تعتمد على ان يكون العنوان مفصولا عن النص, ليمكن العرض المختصر في حالة مراجعة سجل التحديثات بطريقة سهلة
2. كتابة 50 حرف فقط في العنوان.
وهي ليست الحد لكتابة العناوين, بل الحد الحقيقي هو 72 حرف واي زيادة سيتم اخفائها في قيت هب, والرقم 50 انما هو قاعدة نتبعها لنبذل مجهودا اعلى في التلخيص والتوضيح قبل الكتابة العشوائية.
3. جعل الحرف الاول من العنوان كبيرا
للوضوح فقط
4. لا ننهي العنوان بنقطة
حفاظا على المساحة ولقلة الاخطاء
5. كتابة العناوين بصيغة الامر.
لتوحيد اساليب الكتابة حيث انه نفس الاسلوب الكتابي ل قيت,
ممكن استخدام هذا المثال لمساعدتنا على الكتابة بصيغة الامر :
- If applied, this commit will your subject line here
- If applied, this commit will merge pull request #123 from user/branch اذا كتبنا العنوان في المثال السابق ولم يتناسق نحويا فنعلم عندئذ ان عنوانا خاطئ ويجب تعديله
6.نغلف نهاية كتابة النص في 72 حرف
7. نستخدم النص لشرح ماذا ولماذا عوض عن كيف.
الكيفية يشرحها الكود البرمجي, اما عن السبب فمكانها الوحيد في نص رسالة الالتزام.
المراجع: https://www.theodinproject.com/lessons/foundations-commit-messages https://cbea.ms/git-commit/