چگونه در git یک commit خوب بزنیم!؟

قبل از commit زدن باید چه نکاتی رعایت کنیم؟

قبل از اینکه کامیت بزنی، یه کم حواستون باشه:

• تغییراتت رو یه دور کامل چک کنین. مطمئن شین فایل‌هایی که اضافه یا حذف کردی درستن و چیزی جا نمونده.
• پیام کامیت باید واضح و دقیق باشه. نه خیلی کوتاه و مبهم، نه یه داستان حسین کُرد شبستری طولانی. 😁
• اگه شک داشتین چی نوشتین، با دوستاتون یا هم‌تیمی‌هاتون یه بررسی نهایی بکنین.
• اگه نیاز به توضیح بیشتر دارین، می‌تونین از کامیت چندخطی استفاده کنی (با git commit بدون -m).
• قبل از کامیت، مطمئن شین کدت درست کار می‌کنه و پیش‌نیازهای پروژه رو رعایت کردین.
• اطلاعات کاربریتون رو تو گیت تنظیم کرده باشی:

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

توی این روش، پیام کامیت یه ساختار مشخص داره:

نوع(محدوده): توضیح کوتاه

مثلاً:

feat(back-end): add user authentication
fix(front-end): resolve overlap between logout button and avatar
refactor(db): redesign user table to encrypt password

این روش باعث می‌شه تاریخچه‌ی پروژه‌ات خیلی خواناتر بشه، اتوماتیک changelog ساخته بشه و حتی ابزارهای مختلف بتونن ازش استفاده کنن.
جدول زیر انواع رایج این پیشوندها رو نشون می‌ده:

جزئیات مهم برای نوشتن پیام کامیت خوب

اینا نکاتیه که خیلی‌ها فراموش می‌کنن و باعث می‌شه کامیت‌هاشون ضعیف بشه:

1.  از فعل ماضی استفاده نکنین
   پیام کامیت باید به صورت امری و زمان حال نوشته بشه (مثل دستور دادن به گیت).اشتباه: added user authentication یا fixed the bug
   درست: add user authentication یا fix login errorانگار داری به گیت می‌گی «این کار رو انجام بده».
2. توضیحات بیشتر (body) بنویسین
   خط اول (subject) باید کوتاه و خلاصه باشه (معمولاً زیر ۷۲ کاراکتر).
   اگه نیاز به توضیح بیشتر دارین، بعد از یه خط خالی، جزئیات رو بنویسین.
   مثلاً چرا این تغییر لازم بود، چی عوض شد، یا چه چیزی هنوز کامل نشده.
3. چند کار مختلف رو تو یه کامیت قاطی نکن
   هر کامیت باید فقط یه کار منطقی و مستقل باشه (atomic commit).
   اگه هم فیچر اضافه کردی، هم باگ فیکس کردی، هم تست نوشتی، جداشون کن، تا حد ممکن مگر این که مجبور بشی.
   اینطوری بعداً اگه خواستی یه تغییر خاص رو برگردونی یا بازنگری (review) کنی، خیلی راحت‌تره.
4. پیام‌های حاشیه و وضعیت موقت رو فراموش نکن.
   گاهی وقتا کار هنوز کامل نشده. می‌تونی تو توضیحات بنویسین:

   WIP: need to add tests to ensure this function works perfectly

   یا از کلمات کلیدی مثل BREAKING CHANGE: برای تغییرات بزرگ استفاده کنین.

5. نکات دیگه که خیلی کمک می‌کنه:
   1. نقطه در انتهای خط اول نذارین.
   2. از کلمات واضح و انگلیسی ساده استفاده کنین (حتی اگه پروژه‌اتون فارسیه، پیام‌های کامیت معمولاً انگلیسی نوشته می‌شن).
   3. اگه تغییر خیلی مهمه یا API رو به فنا میده، حتماً تو body توضیح بدین که ملت هم بفهمن هدف شما چی بوده.

چند نمونه پیام commit خوب در گیت (با توضیح)