برای طرح سوال و دسترسی به آموزش ها  کانال ما در تلگرام بپویندید  
گیت کامیت خوب

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

کامیت در گیت چیست؟

کامیت (commit) در گیت یک ثبات است که تغییرات فایل ها یا پروژه شما را نشان می‌دهد. هر بار که شما تغییراتی را اعمال می‌کنید و به سیستم گیت اضافه می کنید، یک کامیت جدید به سیستم شما اضافه می شود. هر کامیت شامل یک شماره شناسایی منحصر به فرد هست که برای بازگشت به آن استفاده می شود و همچنین شامل پیامی است که شما توضیح می دهید که چه تغییراتی را ایجاد کرده اید. کامیت ها می توانند برای جلوگیری از از دست دادن تغییرات و کنترل نسخه استفاده شوند.یکی از مهم ترین مواردی که نشان از حرفه‌ای بودن و سطح تخصص شما دارد، کار با گیت و ارائه پروژه های اوپن سورس (متن باز) در گیت است، به ویژه دوستانی که علاقه‌مند به مهاجرت هستند یکی از مواردی که به کارفرمای شما نشون می‌ده که برنامه‌نویس شایسته‌ای هستند پروفایل گیت هاب شماست.

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

قبل از کامیت کردن در Git لازم است که توجه داشته باشید که آیا تمامی تغییراتی که انجام داده اید را به خوبی بررسی کرده اید و رویدادهای خاصی را که ممکن است با به روز رسانی به دلیل اضافه شدن فایل های جدید یا حذف فایل های موجود رخ داده باشد را رد کرده اید. در ادامه، به توضیح نکاتی که قبل از کامیت کردن در گیت باید رعایت کنید می پردازیم:

 

  1. یکی از مهمترین نکات قبل از کامیت کردن در Git بررسی تغییرات است. اطمینان حاصل شود که افزودن یا حذف فایل ها و تغییراتی که در فایل ها ایجاد شده به درستی انجام شده است.
  2. اطمینان حاصل شود که پیغام کامیت برای تغییراتی که انجام داده اید، شرح دهنده و دقیق است.
  3. اگر از تغییرات پرسش دارید، قبل از کامیت کردن با دوستان یا همکاران خود مشورت کنید.
  4. اگر نیاز به توضیحات بیشتر در مورد تغییرات است، می توانید از قابلیت Git commit -m استفاده کنید و پیغام های کامیت را به بخش توضیحات کامل تبدیل کنید.
  5. اطمینان حاصل کنید که قبل از کامیت کردن کدهای موجود، به بررسی پیش‌نیازهای پروژه‌تان بپردازید. یعنی کدهایی که به درستی کار می کنند و از ابزار های موردنیاز استفاده کرده‌اید.
  6. پیش از کامیت کردن، دانش خود را با نحوه کارکرد گیت و سیستم کنترل نسخه خود بسنجید. به عنوان مثال، باید بدانید که گیت از نشانگرها استفاده می کند، برای نشان دادن تغییرات جدید و یا تغییراتی که قبلاً انجام شده است.
  7. با رعایت این نکات قبل از کامیت در Git، اطمینان حاصل شده و بهترین نتیجه را از استفاده از سیستم کنترل نسخه گیت خواهید گرفت
  8. حتما اطلاعات کاربری خود را در گیت با دستور های زیر وارد کنید:
git config --global user.name "نام شما به لاتین"
git config --global user.email "ایمیل شما"
 

 

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

ابتدا باید در نظر گرفت کامیت ها باید به زبان انگلیسی روان و ساده باشد و پیام های commit در گیت، به عنوان یک راه برای توصیف تغییرات انجام شده در فایل های پروژه استفاده می شود. نکاتی که در مورد نحوه نوشتن پیام commit باید رعایت شود شامل:

۱- شروع با فعل : پیام commit شما باید با یک فعل شروع شود که مشخص کننده تغییراتی است که از نسخه قبلی پروژه ایجاد شده است. به عنوان مثال، فعل هایی مانند “اضافه کردن”، “بروزرسانی” و “حذف” می توانند در پیام commit استفاده شوند.

۲- توضیح تغییر: مقصود از توضیح تغییر، توضیح این است که چه تغییراتی در فایل های پروژه صورت گرفته است. می توانید بیشتر جزئیاتی مانند تغییر فایل، تغییر متن کد، تغییرات مرتبط با کارایی و بیشتری در پیام commit خود قرار دهید.

۳- اپلیکیشن شدن تغییرات : به عنوان نکته‌ای مهم، شما باید مشخص کنید که تغییرات شما با چه بخشی از پروژه در ارتباط هستند. ممکن است تغییرات شما مربوط به بخش frontend یا backend باشد، در این صورت باید این موضوع را به واضحیت در پیام commit خود عنوان کنید.

با رعایت موارد بالا به صورت تلفیقی، پیام های commit شما باید با دقت کافی شامل اطلاعات مهمی مانند تغییرات، بخش های مرتبط و محتوای جزئیاتی درباره تغییرات باشد.

 

چند نمونه پیام commit  خوب در گیت:

 

۱- “Added login functionality to the frontend”: این پیام commit بیانگر این است که قابلیت ورود به سامانه به بخش frontend افزوده شد.

۲- “Updated sorting algorithm in backend”: این پیام commit به صورت خلاصه، بیانگر این است که الگوریتم مرتب سازی در بخش backend بروزرسانی شده است.

۳- “Deleted obsolete files in the project”: این پیام commit بیانگر حذف فایل‌های قدیمی و ابا‌نصب شده در پروژه است.

۴- “Fixed bug in email validation function”: این پیام commit بیانگر برطرف کردن یک باگ در تابع اعتبارسنجی پست الکترونیکی است.

۵- “Refactored code in order to improve performance”: این پیام commit بیانگر بهبود عملکرد به وسیله بازنویسی کد پروژه است.

۶- “Integrated payment gateway with the system”: این پیام commit بیانگر ادغام درگاه پرداخت با سامانه است.

۷- “Added new feature for exporting data to Excel”: این پیام commit بیانگر افزودن یک ویژگی جدید به پروژه است که امکان خروجی‌گیری از داده‌ها به فرمت Excel را فراهم می‌کند.

 


انتشار

در

,

توسط

برچسب‌ها:

نظرات

دیدگاهتان را بنویسید

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