کامیت به تغییراتی گفته می‌شود که در ساختار پروژه شما ایجاد و ذخیره می‌شود. هر کدام از این تغییرات را می‌توانید با استفاده از یک متن توصیف کنید که به آن Commit Message یا «پیام کامیت» گفته می‌شود.
زمانی که وارد پروژه‌های متن باز می‌شوید و اولین پروژه خود را شروع می‌کنید، نوشتن درست پیام مربوط به کامیت‌ها به یکی از اصلی‌ترین کارهایی تبدیل خواهد شد که باید به خوبی آن را انجام دهید.
نوشتن پیام کامیت باعث می‌شود تا هم خودتان و هم اعضای تیم‌تان با نگاه بهتری به تغییرات اعمال شده نگاه کنند و به صورت سریع‌تری از تغییرات آگاهی کسب کنند.
در این مطلب از وبسایت راکت با نکات و موضوعاتی آشنا خواهیم شد که شما را در بهتر نوشتن Commit Messageها کمک می‌کند و باعث می‌شود تا از این به بعد به شکل حرفه‌ای‌تری این پیام‌ها را بنویسید.
یک نمونه بد از پیام کامیت
قبل از اینکه سراغ بهترین رویکردها برای کامیت‌نویسی برویم بیایید یک مثال از یک Commit Message بد را مشاهده کنیم و با نقاط ضعف آن آشنا شویم. این کار باعث می‌شود تا با درک بهتری، پیام‌های مناسب‌تری را ایجاد کنیم. مثال:
a few changes.پیام کامیتی که در بالا مشاهده می‌کنید به معنای «یه سری تغییرات» است. این پیام جدای از آنکه ایجاد یکسری تغییرات جدید در کامیت اخیر را گزارش کرده، اما اطلاعات مفیدی را به تحویل گیرنده یا مشاهده کننده مخزن گیت تحویل نمی‌دهد.
برای مثال این تغییرات از چه جنسی هستند، کجا اعمال شده‌اند، مربوط به چه کسی هستند و... .
بنابراین همانطور که مشاهده می‌کنید، در این پیام به جزئیات اصلی هیچ اشاره‌ای نشده و این پیام به عنوان یک پیام مفید نمی‌تواند شناخته شود.
شاخصه‌های یک پیام مناسب چیست؟
برای اینکه به صورت درست‌تری پیام‌های مربوط به هر کامیت را بنویسید نیاز است تا یکسری از نکات را رعایت کنید تا به صورت دقیق‌تری به تغییرات اعمال شده اشاره نمایید.
نکته اول: نوع تغییر مربوطه را بنویسید
برای اینکه به صورت درست و مستقیم به نوع تغییری که اعمال کرده‌اید اشاره کنید، نیاز است تا از یکسری کلمات کلیدی در متن پیام‌تان استفاده کنید. این کار باعث می‌شود تا کسی که مخاطب این دست از پیام‌هاست به صورت سریعی با نوع تغییرات اعمال شده آشنا شود و مفهوم کلی را درک کند.
یکی از این کلمات کلیدی feat است. با استفاده از این کلمه کلیدی شما می‌توانید این پیام را به مخاطب ارائه دهید که یک ویژگی جدید به پروژه‌تان اضافه کرده‌اید. البته در حالت‌هایی نیز این ویژگی جدید منظور همان اطلاعات جدیدی است که وارد یک پروژه می‌شود.
بنابراین اگر پیام بالا را به صورت زیر بنویسیم:
feat: a few changesبه این معناست که شما در فرایند ایجاد یکسری از تغییرات، به پروژه‌تان ویژگی یا ویژگی‌هایی را اضافه کرده‌اید و همچنین اطلاعات جدیدی در پروژه کنونی موجود است. در زیر می‌توانید سه کلمه کلیدی دیگر از این جنس را مشاهده کنید:
- docs: این کلمه کلیدی زمانی استفاده می‌شود که شما مستندات پروژه را اضافه کرده یا در آن تغییراتی را اعمال کرده باشید.
- fix: از این کلمه کلیدی زمانی استفاده می‌شود که شما به حل یک مشکل خاص اشاره کنید. معمولا پس از ایجاد issuesهایی که مطرح می‌شود، این پیام استفاده شده و اشاره به حل همان issue دارد.
- chore: این کلمه کلیدی زمانی استفاده می‌شود که بخواهید به یک مشارکتی اشاره کنید که برای انجام آن زمان نسبتا طولانی به نسبت حالت عادی طی کرده‌اید.
نکته دوم: خلاصه‌نویسی
در فرایند نوشتن پیام مربوط به کامیت‌ها نباید روده‌درازی کرد و متن طولانی را نوشت. بلکه سعی کنید تا مهمترین اتفاقات را با چند کلمه بیان کرده و کلیات تغییراتی که اعمال کرده‌اید را بیان کنید. این موضوع باعث می‌شود تا مخاطب شما به صورت سریع‌تری با کامیت شما آشنا شود.
این موضوع را نیز در نظر بگیرید که گیت‌هاب از یک محدودیت ۷۲ کاراکتری برای متن کامیت‌ها بهره‌بردای می‌کند و به همین دلیل به شما اجازه نمی‌دهد که متن طولانی را بنویسید.
برای مثال اگر بخواهیم کامیت قبلی را درست‌تر بنویسیم و این موضوع را روی آن اعمال کنیم نیاز است تا به شکل زیر عمل نماییم.
feat: added red color button to homepageهمانطور که مشاهده می‌کنید در متن بالا از کلمه کلیدی feat استفاده شده به این معنا که تغییرات یا ویژگی‌های جدیدی به پروژه اضافه شده است. همچنین در متن کامیت، به صورت واضح به این موضوع که یک دکمه قرمز رنگ به صفحه اصلی اضافه شده است، اشاره کرده‌ایم.
نکته سوم: پیاده‌سازی قالب کلی
یکی از کارهایی که بیشتر شرکت‌ها در ساختار داخلی تیم‌ها و مخازن خصوصی خود انجام می‌دهند این است که برای پیام‌های کامیت یک استاندارد یا قالب کلی را طراحی می‌کنند و از آن استفاده می‌کنند.
این قالب سفارشی، از یک ساختار مشخص بهره می‌گیرد و معمولا شامل کلمات کلیدی مختلفی است که از قبل تعریف شده و مفاهیم آن‌ها در نظر گرفته شده است.
برای مثال ممکن است در یک شرکت عبارت X یک معنی خاص داشته باشد و به همین دلیل در ساختار مخازن خصوصی از چنین عبارتی استفاده می‌کنند.
البته این نکته را در نظر بگیرید که چنین رویکردی برای مخازن عمومی نمی‌تواند رویکرد مناسبی باشد دلیل آن نیز ساده است، کاربران از کلمات و عبارات خاص شما متوجه نخواهند شد.
در پایان
بخش بسیار مهمی از فرایند مشارکت در پروژه‌های گیت و گیت‌هاب، افزودن کامیت جدید و استفاده از یک پیام درست برای آن است.
موضوعات بسیار زیادی وجود دارد که در حین نوشتن چنین پیامی باید به آن توجه کنید. در این مطلب ما به ۳ مورد کلی اشاره کردیم. اگر شما نیز موضوع یا تکنیک خاصی را در نظر دارید می‌توانید آن را با ما به اشتراک بگذارید.
دیدگاه و پرسش
در حال دریافت نظرات از سرور، لطفا منتظر بمانید
در حال دریافت نظرات از سرور، لطفا منتظر بمانید