چه تغییری رو commit کنم ؟ چی بنویسم؟ چطور بنویسم؟


اصول commit زدن درست

کامیت ها در گیت، ابزاری برای ثبت تغییرات در پروژه شما هستند. کامیت های خوب و واضح، نه تنها به شما کمک می کنند تا تاریخچه پروژه تان را به طور واضح دنبال کنید، بلکه برای کار تیمی و اشتراک گذاری کد با دیگران نیز ضروری هستند.

در اینجا چند اصل برای commit زدن درست آورده شده است:

1. هر کامیت باید یک تغییر خاص را ثبت کند:

  • سعی کنید هر کامیت را به یک تغییر خاص و مجزا محدود کنید. این کار به شما کمک می کند تا در آینده، به راحتی تغییرات را پیدا و بررسی کنید.
  • برای مثال، به جای اینکه تمام تغییرات مربوط به یک ویژگی جدید را در یک کامیت ثبت کنید، می توانید هر بخش از آن ویژگی را در یک کامیت جداگانه ثبت کنید.

2. از عناوین و توضیحات واضح و مختصر استفاده کنید:

  • عنوان کامیت باید به طور خلاصه، تغییرات را بیان کند.
  • توضیحات کامیت می تواند جزئیات بیشتری را شامل شود، مانند دلیل انجام تغییر، نحوه انجام آن و هر گونه اطلاعات دیگری که برای درک بهتر آن تغییر لازم است.
  • از عناوین و توضیحات طولانی و مبهم خودداری کنید.

3. از کلمات کلیدی مناسب استفاده کنید:

  • می توانید از کلمات کلیدی در عنوان و توضیحات کامیت خود استفاده کنید تا پیدا کردن آنها در آینده آسان تر شود.
  • برای مثال، می توانید از کلماتی مانند "bug fix" یا "feature" یا "chore" برای دسته بندی تغییرات خود استفاده کنید.

4. از دستور git add برای انتخاب فایل های مورد نظر برای commit استفاده کنید:

  • قبل از commit کردن، از دستور git add برای انتخاب فایل هایی که می خواهید در آن کامیت ثبت شوند استفاده کنید.
  • این کار به شما کمک می کند تا فقط تغییراتی که می خواهید را ثبت کنید و از ثبت تصادفی فایل های ناخواسته جلوگیری کنید.

5. از دستور git commit برای ثبت تغییرات استفاده کنید:

  • پس از انتخاب فایل های مورد نظر، از دستور git commit برای ثبت تغییرات استفاده کنید.
  • در این مرحله، باید عنوان و توضیحات کامیت خود را وارد کنید.

6. از دستور git push برای به اشتراک گذاری تغییرات خود با دیگران استفاده کنید:

  • پس از commit کردن تغییرات، می توانید از دستور git push برای به اشتراک گذاری آنها با دیگران در یک مخزن راه دور (remote repository) استفاده کنید.

نکات اضافی:

  • می توانید از امضای دیجیتال (digital signature) برای تأیید اصالت کامیت های خود استفاده کنید.
  • می توانید از ابزارهای مختلفی برای مدیریت کامیت های خود استفاده کنید، مانند Git GUI یا SourceTree.

با رعایت این اصول، می توانید کامیت های واضح و منظمی داشته باشید که به شما و دیگران در درک بهتر تاریخچه پروژه تان کمک می کند.

منابع:

https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/

------------------------------------------------------------------------------------------------------------

این یکی از صدها مطلب و نکاتی هستش که ما توی چنل تلگراممون قرار میدیم. ما اونجا حتی یه گروهم داریم که نزدیک به 1000 نفر عضو داره و هر سوالی در رابطه با جاوااسکریپت و ریکت و بک اند و ... داشته باشید اعضای گروه کمکتون میکنن

ضمنا بهترین دوره جاوااسکریپت جهان رو هم داخلش قرار دادیم کاملا رایگان ✌️

یه سر بهمون بزن ❤️

https://t.me/js_challenges

نویسنده این مقاله کوتاه :

https://www.linkedin.com/in/amir-nobari1990/

https://github.com/amirnobari