چگونه یک پیغام کامیت خوب بنویسیم؟

نوشتن یک پیغام کامیت خوب برای گیت‌هاب (GitHub) می‌تواند به شما و همکارانتان کمک کند که به راحتی تغییرات کد را دنبال کنید و درک بهتری از تاریخچه پروژه داشته باشید. در این پست نکاتی برای نوشتن یک پیغام کامیت خوب آورده شده است:

فرمت نهایی پیغام کامیت:

نکات مهم:

• 1. متن پیغام خود را بهتر است در حالت امری بنویسید، به عنوان مثال :

fix: fix bug

• 2. کوتاه و خلاصه بنویسید. سعی کنید پیغام کامیت خود را در 50 کاراکتر خلاصه کنید تا در صفحه گیت هاب به درستی خوانده و دیده شود. همچنین از کلمات و نماد های غیرضروری خودداری کنید.
• 3. اول پیغام خود را با حرف بزرگ شروع کنید.

بررسی کامل فرمت پیغام کامیت:

• مورد اول <Type> : برای نشان دادن نوع تغییرات موجود باید نوع تغییر را با یکی از انواع زیر مشخص کنید:

1. کلمه کلیدی feat : برای خلاصه کردن یک ویژگی جدید در کدمان.
2. کلمه کلیدی fix : زمانی که دیباگی را در کد انجام دادید با این پیغام کد خود را کامیت کنید.
3. کلمه های کلیدی دیگری را مثل refactor ، style ، ci و build را هم می توانید استفاده کنید.

• مورد دوم (scope): این مورد را به ادامه type اضافه می کنیم تا اطلاعات مختصری درباره نوع تغییر داشته باشیم.
• مورد سوم (body): این مورد برای اضافه کردن توضیحات بیشتر پیغام کامیت است. شکل نوشتاری آن به این صورت است که بعد از پیغام اصلی یعنی (<Type> ([optional scope]): <description>) یک خط فاصله می اندازیم بعد شروع به نوشتن می کنیم . توجه: توضیحات بهتر است 72 کاراکتر باشد.
• مورد چهارم (footer): پاورقی برای اطلاعات اضافی مانند بررسی شده یا نوشته شده توسط فرد مربوطه است.به عنوان مثال:

Signed-by : Sadegh<Sadegh@gmail.com>

و footer هم بعد از body یک خط فاصله می دهیم.

نکته : در پروژه های شخصی خود می توانید فقط از بخش اصلی (<Type> ([optional scope]): <description>) استفاده کنید و معمولا در پروژه های شخصی دو بخش بعدی دلبخواهی است.

مثال واقعی با استفاده از فرمت گفته شده:

ممنون که تا آخر این پست همراه من بودید ، امیدوارم براتون مفید بوده باشه 🙌🙏✌ (:

بقیه آموزش های من با نام (mister developer) را می توانید در تلگرام و اینستاگرام دنبال کنید!!

کانال تلگرام: mister_developerr

اینستاگرام: mister_developerr

موفق و پیروز باشید