البدء

تعلم اتفاقية الالتزام لدينا

2 min read
259 words

نحب أن تكون لدينا تاريخ مشروع نظيف. يعتمد تقليد الالتزامات لدينا على Conventional Commits ولكنه مُخصص باستخدام gitmoji ليكون أكثر بصرية ومرحًا.

الهيكل

يجب أن تكون رسالة الالتزام منظمة على النحو التالي وبالحروف الصغيرة:

<gitmoji> <type> <description> [(#<issue number>)]

[optional body]

[optional footer(s)]

مثال

📝 تحديث مساهمات الوثائق

- إضافة @jerembdn كمساهم
- إضافة @younesbessa كمساهم

Co-authored-by: Younes Bessa <[email protected]>

معظم الوقت، سطر واحد بسيط يكفي:

📝 تحديث مساهمات الوثائق

الأنواع

نستخدم الأنواع التالية من الالتزامات:

النوعالوصف
addإضافة ميزة جديدة
fixإصلاح خطأ
improveتحسين شيء ما
updateتحديث شيء ما
removeإزالة شيء ما
refactorإعادة هيكلة شيء ما
renameإعادة تسمية شيء ما
moveنقل ملف أو مجلد
upgradeترقية التبعيات
downgradeخفض التبعيات

الوصف

اكتب الأوصاف في أسلوب الأمر وبالخروف الصغيرة:

# جيد
📝 تحديث مساهمات الوثائق

# سيئ
📝 تم تحديث مساهمات الوثائق

# سيئ
📝 تحديث مساهمات الوثائق

رقم القضية

اربط الالتزامات بالقضايا عن طريق إضافة رقم القضية:

📝 تحديث مساهمات الوثائق (#123)

الجسم

استخدم الجسم للسياق والدافع:

📝 تحديث مساهمات الوثائق

- إضافة @jerembdn كمساهم
- إضافة @younesbessa كمساهم

Co-authored-by: Younes Bessa <[email protected]>

التزام واحد، غرض واحد

يجب أن يمثل كل التزام تغيير منطقي واحد. لا تخلط بين التغييرات غير المرتبطة.