وقتی صحبت از کنترل نسخه به میان می آید، Git ابزار بسیار موثری است. با این حال، مانند هر ابزار دیگری، باید از آن به روش صحیح استفاده کنید تا بیشترین بهره را از آن ببرید. جنبه های مختلفی وجود دارد که باید در نظر بگیرید. این مقاله بر نحوه نوشتن پیام‌های commit موثر Git با توجه به مشخصات Commits معمولی تمرکز دارد. این اصول اصولی را برای کمک به شما در ایجاد پیام های تعهدی شفاف، آموزنده و استاندارد بیان می کند.
یک پیام commit خوب چگونه به نظر می رسد؟
هدف از ارسال پیام برقراری ارتباط است. برای اینکه ارتباط موثر باشد، گیرنده باید به وضوح بفهمد که فرستنده پیام چه چیزی را می خواهد به او بگوید. بنابراین شما باید زمینه و اطلاعات کافی را ارائه دهید. بر این اساس، یک پیام commit خوب باید موارد زیر را منتقل کند:
1. نوع (اجباری)
-
fix:– زمانی که عمل در حال رفع یک باگ است قابل استفاده است. -
feat:– زمانی که یک ویژگی جدید اضافه می کنید قابل استفاده است. -
BREAKING CHANGE:– هنگامی که تغییری را معرفی می کنید که ممکن است نیاز به به روز رسانی یا ارتقاء برخی از جنبه های برنامه داشته باشد تا از اختلالات جلوگیری شود، قابل استفاده است. به عنوان مثال، جایگزینی منابع منسوخ شده با منابع جدید ممکن است در صورت عدم سازگاری با عقب، عملکرد را مختل کند. همچنین می توانید با استفاده از نماد ‘!’ تغییر شکسته را نشان دهید. درست بعد از نوع (یا محدوده در صورت وجود). مثال؛ ‘feat (احراز هویت)!:’ -
docs:– قابل اجرا برای اسناد
دیگران شامل تست: , کار: , Refactor: , ساخت: , سبک: و غیره. اگر بخشی از یک تیم هستید، ممکن است یک کنوانسیون با انواع سفارشی وجود داشته باشد که انتظار می رود به آن پایبند باشید. بنابراین مهم است که از قبل جزئیات را دریافت کنید.
2. دامنه (اختیاری)
اگرچه ارائه دامنه اختیاری است، اما تمرین خوبی است که آن را برای وضوح درج کنید. دامنه بخشی از پایگاه کد تحت تأثیر تغییرات را مشخص می کند، بنابراین به خوانندگان کمک می کند تا زمینه تغییر را درک کنند. این به ویژه در پروژه های بزرگ با مشارکت کنندگان بسیار مفید است. همکاری را آسان تر می کند.
3. توضیحات (اجباری)
این قسمتی است که شما در آن کارهایی را که انجام داده اید توصیف می کنید. آن را مختصر و مستقیم به سر اصل مطلب نگه دارید. مطمئن شوید که آن را به صورت امری بنویسید. به عنوان مثال، به جای نوشتن «مکانیسم احراز هویت اضافه شده»، باید «افزودن مکانیزم احراز هویت» را بنویسید. این خوانایی را در لاگ های تغییرات و یادداشت های انتشار به طور خودکار ایجاد می کند.
4. بدنه (اختیاری)
اینجا جایی است که می توانید اطلاعات بیشتری در مورد آنچه پیاده سازی کرده اید ارائه دهید. از یک خط خالی برای جدا کردن بدنه از توضیحات استفاده کنید.
5. پاورقی (اختیاری)
اگر ابرداده‌ای وجود دارد که می‌خواهید آن را در پاورقی اضافه کنید. برای مثال، اگر تغییری که ایجاد کرده‌اید به مشکلی می‌پردازد که قبلاً مطرح شده بود، می‌توانید آن را در اینجا با ذکر شماره مرجع نشان دهید. مثال؛ ‘رفع #003‘
همچنین می‌توانید نام داور را در فوتر قرار دهید.
به یاد داشته باشید، قبل از ارائه توضیحات، یک scope باید با علامت دو نقطه و فاصله دنبال شود. همچنین باید به خاطر داشته باشید که BREAKING CHANGE وقتی در پاورقی قرار می گیرد به حروف بزرگ و کوچک حساس است، بنابراین باید با حروف بزرگ نوشته شود.
مثال ها
- chore (Art_func): متغیر “Empty” را به “Empty” تغییر دهید
نام متغیر را از “Empty” به “Empty” برای سازگاری با آن تغییر دهید
قرارداد نامگذاری
- fix(پایگاه داده)!: اصلاح طرح
طرحواره را طوری تغییر دهید که فقط داده های ساخت یافته را در خود جای دهد. اخراج همه
انواع دیگر داده ها
- شاهکار: اضافه کردن پشتیبانی از حالت تاریک.
برای پیام های طولانی، با اجرا از یک ویرایشگر متن استفاده کنید
git commit
بدون پرچم -m. این یک ویرایشگر را باز می کند که در آن می توانید یک پیام commit دقیق بنویسید. برای پیام‌های کوتاه‌تر، فقط می‌توانید پرچم -m را اضافه کنید و به جای ویرایشگر از ترمینال استفاده کنید.
git commit -m "subject" -m "body"
استفاده از چندین پرچم -m به شما کمک می کند تا با جدا کردن موضوع، متن و پاورقی، پیام را به درستی قالب بندی کنید.
نتیجه
نوشتن یک پیام تعهد باید در خدمت هدف مورد نظر باشد. برای اینکه واضح و آموزنده باشد، توصیه می شود حداقل نوع و شرح تغییراتی که ایجاد کرده اید را درج کنید. برای حفظ یک پایگاه کد خوب که بتواند از همکاری و اتوماسیون فرآیندهای مختلف پشتیبانی کند، از رویکرد مرسوم پیروی کنید. برای کسب اطلاعات دقیق، حتماً دستورالعمل‌های متعارف را دنبال کنید.
