توصیه هایی برای Commit Messages در Git

git_commit

قبلا در مورد Git مطالبی نوشته بودم. قدرت گیت در کارهای تیمی بسیار مشخص تر خواهد بود. رعایت کردن یکسری استاندارد بین افراد یک پروژه می تواند روند کارها را سریعتر و اشتباهات را کاهش دهد. یکی از این استانداردها می تواند تدوین قوانینی برای نوشتن توضیحات برای Commitها در گیت باشد. در ادامه توصیه هایی شخصی را می بینید که ما در تیممان در این راستا رعایت می کنیم:

نکات:

مختصر و مفید. با توجه به محدودیت در نوشتن عنوان Commit، این بخش باید تا جای ممکن ساده، مختصر و مفید نوشته بشود که در آینده در صورت مشاهده آن بتوان براحتی محتویات و موضوع آن را فهمید. البته در Git می توان توضیحاتی را نیز در بخش Commit نیز وارد کرد که با توجه به نوع پروژه هایی که ما انجام می دهیم معمولا نیازی به آن نمی شود ولی بسیار مفید می تواند باشد.

نوشتن در مورد ” چرا ” و نه ” چطور “. بطور مثال نگوییم فانکشن ایکس اضافه شد، بگوییم حل مشکل نمایش لینک به کاربر. با توجه به اینکه براحتی می توان فایل هایی تغییر داده شده در یک Commit را مشاهده کرد، بنابراین ارائه صورت مسئله بهتر از عنوان کار فنی ای هست که انجام شده است.

قوانین:

کلمه آغازین. ما یکسری کلمه برای شروع پیام مشخص کردیم که می تواند به خوانایی و خلاصه کردن متن کمک کند:

  • New: اگر محتوای Commit در رابطه با افزودن قابلیت ویا بخش جدیدی به محصول است.
  • Update: اگر محتوای Commit در رابطه با بروزرسانی قابلیت ویا بهبودی به بخشی که وجود دارد است.
  • Fix: اگر محتوای Commit شامل رفع اشکال در بخشی از محصول است.

بسته به نوع پروژه کلمات دیگری نیز می تواند وجود داشته باشد، بطور مثال: Release, Field, DB و… .

ارتباط با برنامه مدیریت پروژه: در بالا عنوان شد که ما معمولا از بخش توضیحات Commit Messages استفاده نمی کنیم. برای حل این مشکل ما با وارد کردن شماره تسک مرتبط با Commit در پیام تا حد زیادی این کمبود را برطرف می کنیم. برای اینکار از # استفاده می کنیم. بطور مثال اگر Commit مربوط به تسک شماره 142 باشد می تواند عنوان Commit این باشد:

Fix: Do not activate plugins on initial installation #142

در همین رابطه مطالعه مطالب زیر نیز توصیه می شود:

 

2 دیدگاه

پاسخ دهید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *