البدء
تعلم اتفاقياتنا عند الالتزام
نحب أن يكون لدينا تاريخ مشروع نظيف. إن تقليد الالتزامات لدينا مستلهم من Conventional Commits ولكن مُخصص بـ gitmoji لجعله أكثر وضوحًا ومتعة.
الهيكل
يجب أن تكون رسالة الالتزام منظمة كما يلي و بالحروف الصغيرة:
<gitmoji> <type> <description> [(#<issue number>)]
[optional body]
[optional footer(s)]
مثال
📝 تحديث وثائق المساهمين
- إضافة @jerembdn كمساهم
- إضافة @younesbessa كمساهم
المؤلف المساعد: يونس بيسة <[email protected]>
معظم الوقت، سطر بسيط يكفي:
📝 تحديث وثائق المساهمين
الأنواع
نستخدم الأنواع التالية من الالتزامات:
| النوع | الوصف |
|---|---|
add | إضافة ميزة جديدة |
fix | إصلاح خطأ |
improve | تحسين شيء ما |
update | تحديث شيء ما |
remove | إزالة شيء ما |
refactor | إعادة هيكلة شيء ما |
rename | إعادة تسمية شيء ما |
move | نقل ملف أو مجلد |
upgrade | تحديث الاعتمادات |
downgrade | إنقاص الاعتمادات |
initial | الالتزام الأول لمستودع |
release | إصدار / علامة الإصدار |
يستخدم أول التزام لمستودع initial، وتستخدم علامة الإصدار release:
🎉 الالتزام الأول
🔖 إصدار @onruntime/translations v0.3.0
الوصف
الـ <type> هو الفعل للموضوع، والوصف يكمل ذلك. عندما تُقرأ معًا، تشكل جملة واحدة:
# جيد
📝 تحديث وثائق المساهمين
لذا لا تفتح الوصف بفعل ثانٍ. النوع هو بالفعل فعل، وينتهي الموضوع بتكديس جملتين، وهو ما يؤدي إليه بادئة fix:. اترك الفعل واحتفظ بما تم التصرف عليه:
# سيء
💄 تحسين تقليص حجم الجوهرة على بطاقتها
🐛 إصلاح توقف تداخل التذييل
# جيد
💄 تحسين حجم الجوهرة على بطاقتها
🐛 إصلاح تداخل التذييل
اكتبها في حالة الأمر و الحروف الصغيرة:
# سيء
📝 تم تحديث وثائق المساهمين
# سيء
📝 تحديث وثائق المساهمين
فعل هو اسم
بعض الكلمات هي كليهما، والكلمة التي تعنيها هي الاسم: ✨ إضافة صورة غلاف مفتوح
جيدة. عندما تُقرأ كفعل، فإن وجود أداة يجعلها عبارة اسمية مرة أخرى:
✨ إضافة زر "عرض المزيد".
رقم القضية
رابط الالتزامات بالقضايا عن طريق إضافة رقم القضية:
📝 تحديث وثائق المساهمين (#123)
الجسم
استخدم الجسم للسياق والدافع:
📝 تحديث وثائق المساهمين
- إضافة @jerembdn كمساهم
- إضافة @younesbessa كمساهم
المؤلف المساعد: يونس بيسة <[email protected]>
التزام واحد، غرض واحد
يجب أن يمثل كل التزام تغييرًا منطقيًا واحدًا. لا تخلط التغييرات غير ذات الصلة.