راهنمای جامع Conventional Commits + سازنده زنده کامیت
استاندارد Conventional Commits چیست؟
Conventional Commits یک استاندارد رسمی و ساختارمند برای نوشتن پیامهای کامیت است که باعث میشود تاریخچه پروژه واضح، قابل اتوماسیون، قابل جستجو و قابل درک برای انسان و ماشین باشد.
چرا مهم است؟
- ✔ ایجاد هماهنگی تیمی
- ✔ تولید خودکار CHANGELOG
- ✔ تعیین نوع نسخه (Semantic Versioning) به شکل خودکار
- ✔ قابلیت پردازش توسط ابزارها (Release automation / CI/CD)
- ✔ مشخص کردن دلیل هر تغییر
ساختار پیام کامیت
type(scope): short description
body (optional)
BREAKING CHANGE: details (optional)
footer (optional)
در ادامه تمامی بخشها را با جزئیات توضیح دادهایم:
1) type
نوع تغییر انجامشده را مشخص میکند.
- feat: قابلیت جدید
- fix: رفع باگ
- docs: تغییر مستندات
- style: تغییر ظاهر/فرمت کد
- refactor: بازطراحی کد بدون تغییر رفتار
- perf: بهبود عملکرد
- test: اضافه/اصلاح تست
- build: تنظیمات Build
- ci: تنظیمات CI/CD
- chore: کارهای متفرقه
- revert: بازگردانی کامیت
2) scope
دامنه تغییرات؛ مثل ui, auth, api
3) description
توضیح خیلی کوتاه، مختصر و دقیق درباره تغییر
4) body (optional)
توضیح کامل درباره چرایی تغییر
5) BREAKING CHANGE (optional)
اگر رفتار سیستم شکسته و ناسازگار شده باشد باید استفاده شود.
6) footer
ارجاع، شماره Issue، لینک، اطلاعات اضافی