چگونه یک commit با معنا در git بنویسیم؟ 💀

نوشتن کامیت خوب یک هنره و این زمانی بیشتر خودشو نشون میده که در یک تیم مشغول به کار باشید.

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


هدف از نوشتن commit با معنا چیه؟ 🤔

🔵 تولید خودکار فایل CHANGELOG.md توسط اسکریپت

🔵 در نظر نگرفتن بعضی از کامیت های بی اهمیت با git bisect (مثل فورمت کردن کدها)

🔵 داشتن اطلاعات بهتر و کاراتر هنگام بازببینی تاریخچه کامیت ها


هر خط از پیغام کامیت نباید بیشتر از 100 کاراکتر باشه. همین باعث میشه که خوندن متن کامیت هم در گیتهاب و هم در سایر ابزار های گیت آسون تر باشه. هر متن کامیت دارای سرآمد (header)، بدنه (body) و بخش زیرین (footer) هست که توسط خط خالی (Blank line) از هم جدا میشن.


متن سرآمد

متن قسمت سرآمد یک خطه که به صورت خلاصه وار توضیحاتی در مورد تغییرات ارائه میده و شامل نوع (type)، محدوده [تغییرات] (scope) و موضوع (subject) هست.

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


🔵 feat
🔵 fix
🔵 docs
🔵 refactor
🔵 test
🔵 chore


متن بدنه

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

متن بخش زیرین

در این بخش برخی اطلاعات خاص در مورد commit ارائه میشه مثل BREAKING CHANGE.
این مورد در فوتر به عنوان یک توضیحات آورده میشه. همونطور که از اسمش هم مشخصه اگه یک تغییر اساسی در پروژه و فایلی داشتیم این مورد باید حتما اضافه بشه.



اطلاعات بیشتر و میتونید تو این مقاله مطالعه، و یک پله خودتون و نسبت به سایر دولوپر ها حرفه ای تر کنید⚡️

#commit #git
@CodeModule