مدقق Conventional Commits

رسالة commit يتكون سطرها الأول من نوع، ثم نطاق اختياري بين قوسين، ثم نقطتين، ثم مسافة، ثم وصف قصير، مثل fix(api): handle empty response. تأتي الصيغة من مواصفة Conventional Commits 1.0.0، وتستخدمها الأدوات لاختيار رقم الإصدار التالي وكتابة سجلات التغييرات تلقائياً.

استخدم feat لتغيير يراه المستخدمون قدرة جديدة، وfix لإصلاح خطأ، وchore لأعمال الصيانة التي لا تغيّر أياً منهما، مثل تحديث الاعتماديات. وتتبعها الإصدارات: feat يُنتج إصدار minor، وfix إصدار patch، وchore لا يُنتج إصداراً وحده. أما docs وstyle وrefactor وperf وtest وbuild وci فهي الأنواع القياسية الأخرى.

ضع علامة تعجب قبل النقطتين، كما في feat(api)!: remove the v1 endpoints، أو أضف بعد سطر فارغ تذييلاً يبدأ بـ BREAKING CHANGE: ويذكر ما الذي يتعطل. أيٌّ منهما يجعل الإصدار major مهما كان النوع. واستخدامهما معاً مسموح وشائع.

عادةً لأن العنوان لا يطابق type: description تماماً، فلا يجد commitlint نوعاً ولا وصفاً. من الأسباب الشائعة غياب المسافة بعد النقطتين، أو وجود مسافة قبلهما، أو نوع بحرف كبير أو غير معروف، أو عدم وجود نوع أصلاً. الصق الرسالة هنا لترى أي جزء قُرئ خطأً.

ليس مع config-conventional: فقاعدته subject-case ترفض الأوصاف المكتوبة بـ sentence case أو start case أو pascal case أو upper case، لذا يفشل Add login وينجح add login. يُتجاهل النص الموضوع بين علامات backtick أو علامات الاقتباس في هذه القاعدة، لذا لا مشكلة في اسم مثل `Button` في البداية. الفرق التي تريد الأحرف الكبيرة تغيّر القاعدة في إعداداتها الخاصة.

لا. افتراضياً يتخطى commitlint الـ merge commits، وعمليات revert التي يكتبها git، وcommits من نوع fixup! وsquash!، والعناوين التي ليست سوى رقم إصدار مثل 1.2.3 أو chore(release): 1.2.3. تتخطى هذه الصفحة الرسائل نفسها وتذكر ذلك، فيعطي الفحص هنا الإجابة نفسها التي يعطيها الـ hook.