وقتی در تیمی شروع به کار و کدزنی می کنید یکی از مهمترین ابزارها برای تعامل در کدزنی استفاده از گیت است. پیام های کامیت خیلی مهم هستند و چالشی که شاید اکثر برنامه نویس ها استفاده کننده از گیت با آن روبرو هستند، انتخاب متنی مناسب برای commit است. در این مقاله به مواردی که میتواند در commit نویسی تمیز و خوانا موثر باشد، پرداخته شده است.
1- خلاصه کوتاه از کاری که کردید را بنویسید.
2- هر لاینی بهتر است که بیشتر از 50 تا کاراکتر(حرف) نباشد چون در یک صفحه باید قابل نمایش باشد. هرچه لاین کمتر باشد خوانایی بیشتر است و بهتر خوانده میشود. البته میشود خط رو هم بشکونید یک خط سفید و در خط های بعدی توضیحات کاری رو که کردید رو دنبال کنید که البته این مورد اختیاری است. اما اگر این خط را نذارید گیت همه را در یک خط قرار میدهد و مانند wordProcessor های دیگر مثل microsoft word نیست که خودش خط را بشکوند. به عبارتی دیگر کامیت های گیت word wrap ندارد.
3- پیام ها را بصورت فعل حال (present tense )بنویسید نه فعل ماضی(past tense). مثال درست fix bug.
4- بجای استفاده از بولت پوینت ها از ستاره و یا خط فاصله استفاده کنید. برای مرتب کردن متن .
5- البته برای سریعتر خواندن میتوانید از شماره گذاری هم استفاده کنید.
[js,css,htm] message
در مثال بالا نشان میدهد که پیامتون در مورد فرانت هست و در مورد programming نیست .
bugfix: message
یعنی باگی را درست کردین و پیام مربوط به باگی که فیکس شده جلوش قرار میدهید.
#23 - message
شماره گذاری کنید. هشتگ نماد معرف شماره کامیت میباشد.
در تصویر زیر نمونه ایی از کامیت های نادرست و درست آورده شده است.
در عکس بالا مورد آخر، بدترین شکل کامیت کردن هست که تغییرات را نمایش نمیدهد و حالت یک مکالمه است که اصلا درست نیست.
در تصویر زیر یک نمونه کامیت درست را نمایش می دهد :
که کامیت شماره گذاری دارد و بعد با یک خط خالی آنرا جدا کرده است و بقیه متن را نوشته است.
شما چه استانداردها و الگوهایی رو برای کامیت نویسی رعایت میکنید. کامنت بزارید که من هم استفاده کنم.
منبع: پارس کلیک
