بهترین روش‌های تدوین پیام Git Commit

Git، پایه کنترل نسخه امروزی، قدرت فوق العاده ای را در اختیار تیم های توسعه قرار می دهد. با این حال، پتانسیل واقعی آن زمانی که با پیام‌های commit دقیق و ساختارمند ترکیب شود، به بهترین وجه درک می‌شود. این پیام ها خرده نان های مهمی برای درک پیشرفت نرم افزار شما فراهم می کنند. بیایید به بهترین شیوه ها برای نوشتن پیام های متعهد Git موثر که همکاری و سرعت توسعه را بهبود می بخشد نگاه کنیم.

پیام ارتکاب آناتومی یک ستاره:

1. نوع تغییر (ضروری):

• fix: سیگنال تفکیک یک باگ.
• feat: نشان دهنده معرفی یک ویژگی جدید است.
• BREAKING CHANGE: اصلاحاتی را برجسته می‌کند که ممکن است برای جلوگیری از مشکلات سازگاری، مانند جایگزینی اجزای قدیمی، نیاز به به‌روزرسانی داشته باشد. شما همچنین می توانید “!” را اضافه کنید نماد بعد از نوع/منطقه
• docs: برای به روز رسانی و اصلاحات در اسناد محفوظ است.
• سایر انواع پرکاربرد عبارتند از test:، chore:، refactor:، build:، و style:. به خاطر داشته باشید که تیم ها اغلب از انواع سفارشی استفاده می کنند، بنابراین مطمئن شوید که رویه های شما از قوانین تعیین شده توسط تیم شما پیروی می کند.

2. منطقه آسیب دیده (اختیاری):

ناحیه آسیب‌دیده، بخش خاصی از پایگاه کد تحت تأثیر تغییرات را مشخص می‌کند. گنجاندن این عنصر، به خصوص در پروژه‌های بزرگی که چندین توسعه‌دهنده در آن شرکت دارند، وضوح و زمینه را به ارمغان می‌آورد.

3. خلاصه مختصر (ضروری):

این قسمت را مختصر و دقیق نگه دارید. از حالت امری استفاده کنید – به عنوان مثال، “اجرای احراز هویت کاربر” به جای “تأیید هویت اجرا شده کاربر”. این عمل خوانایی را در گزارش‌های تغییرات و یادداشت‌های انتشار به‌طور خودکار ایجاد می‌کند.

4. توضیح مفصل (اختیاری):

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

5. اطلاعات اضافی (اختیاری):

هر ابرداده مربوطه را در اینجا درج کنید، مانند پیوندی به مشکلی که قبلا گزارش شده است (fix #003) یا نام بازبینی کننده کد.

به خاطر داشته باشید که وقتی یک ناحیه آسیب دیده را وارد می کنید، همیشه قبل از نوشتن خلاصه مختصر، آن را با دو نقطه و فاصله دنبال کنید. علاوه بر این، BREAKING CHANGE به حروف کوچک و بزرگ حساس است و باید با حروف بزرگ نوشته شود.

مثال های گویا:

chore(Style_Guide): Rename variable “InvalidInput” to “invalidInput”

Rename variable to adhere to the established naming convention for improved consistency.

fix(Data_Processing)!: Update data validation rules

Revised data validation rules to exclusively accept structured data. All other data formats will be rejected.

feat: Integrate night mode functionality

برای پیام های گسترده تر، این مورد را حذف کنید -m پرچم در طول فرآیند commit. این عمل یک ویرایشگر را باز می‌کند که امکان ارسال پیام جامع را فراهم می‌کند. برای پیام های کوتاه تر، استفاده کنید git commit -m "summary" -m "explanation" خلاصه، توضیح و اطلاعات اضافی را به طور مشخص جدا کنید.

در نتیجه:

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