پیام کامیت Conventional Commits بسازید یا پیام خود را بررسی کنید
پیام کامیت خوب به همتیمیها، و به خود شما چند ماه بعد، میگوید هر تغییر چه بود و چرا انجام شد. قالب Conventional Commits این پیامها را یکدست میکند: نوع تغییر، دامنهی اختیاری و یک توضیح کوتاه، مثل fix(parser): handle empty input. ابزارهایی مثل semantic-release و changelogسازها از همین قالب نسخهی بعدی و فهرست تغییرات را میسازند.
این ابزار پیام را مرحلهبهمرحله میسازد، بدنه را در ۷۲ نویسه میشکند، پاورقیهایی مثل Refs و Co-authored-by را اضافه میکند، پیام آماده را بررسی میکند و یک راهنمای کوتاه از دستورهای رایج git هم دارد. همهچیز در مرورگر شما انجام میشود.
نوع تغییر را انتخاب کنید
در «ساخت پیام» نوع را از میان feat، fix، docs، refactor و بقیه بردارید و در صورت نیاز «دامنه (اختیاری)» را بنویسید، مثلاً auth.
توضیح کوتاه را بنویسید
در «توضیح کوتاه» با فعل امری و بدون نقطهی پایانی بگویید چه کردید؛ طول خط اول در پیشنمایش شمرده میشود و بهتر است از ۷۲ نویسه نگذرد.
بدنه و پاورقی را اضافه کنید
دلیل تغییر را در بدنه بنویسید و اگر تغییر ناسازگار است «تغییر ناسازگار» را روشن کنید. پاورقیهایی مثل Closes یا Co-authored-by را از «پاورقیها» اضافه کنید.
پیام آماده را بررسی کنید
در «بررسی پیام» یک پیام موجود را بچسبانید تا ایرادهای قالبش با توضیح فارسی گزارش شوند.
ساخت یک پیام رفع اشکال
نوع fix، دامنهی parser و توضیح کوتاه انگلیسی آماده میشوند.
نتیجه: fix(parser): handle empty input
بررسی پیامی بیقالب
پیامی که نوع و دونقطه ندارد، با قالب سازگار نیست.
Fixed the bug.
نتیجه: خط اول باید به شکل «نوع(دامنه): توضیح» باشد؛ مثلاً «feat(auth): add login form». دامنه اختیاری است ولی بعد از «:» باید فاصله بیاید.
طول خط اول: ۶ از ۷۲ نویسه