در این مقاله یک استاندارد کوچک برای نوشتن توضیحات git ارائه می شود. طبیعتاً این استاندارد جهانی نیست و برداشت نویسنده مقاله می باشد.
یکی از مسایل مهم هنگامی که از git استفاده می نماید این است که در داخل تیم یک استاندارد کلی وجود داشته باشد که وقتی سایرین به تاریخچه ی تغییرات نگاه می کنند بتوانند تغییرات را ردگیری کنند و متوجه اتفاقات کلی پروژه بشوند.
در همین راستا یک استاندارد کلی برای توضیحات commit در git ارائه می شود. صد البته که هر تیمی استاندارد های خودش را دارد و موارد ارائه شده در ایم مقاله وحی مُنزَل نیست.
استاندارد معرفی شده بسیار ساده است و به صورت زیر می باشد:
<type> - <module> (<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
-
برای type باید از یکی از موارد زیر استفاده شود (حتما از حروف کوچک استفاده شود) و این مورد هم ضروری است:
- fix : رفع مشکل (Bug) در کد
- feat : افزودن یک امکان جدید (Feature) به پروژه
- docs: ایجاد تغییر در توضیحات و راهنماها
- build: تغییرات در build پروژه و فایل های مرتبط
- perf: تغییرات در کد برای بهبود کیفیت و کارایی (performance)
- refactor : مرتب کردن کدها و جابجایی و ماژولار کردن (با رفع مشکل نباید اشتباه شود)
- style : مرتب کردن کد (افزودن فاصله ها و ایندنت ها و اصلاح فرمت نوشتاری کد)
- test : افزودن کدهای مربوط به تست پروژه
- temp: افزودن کد به صورت موقت و حذف یا تغییر آن در آینده
- نام ماژول، یکی از ماژول های نرم افزار خواهد بود و صد البته ضروری است.
-
برای scope باید یکی از موارد زیر استفاده شود. البته استفاده از scope اختیاری است:
-
core
- release
- forms
- router
-
http
- common
- interface
- language
- compiler
- upgrade
توجه:
- در انتهای عنوان به هیچ وجه از نقطه استفاده نشود.
- از شوخی و طعنه در عناوین استفاده نشود.
-
در حد امکان خلاصه و گویا باشد.
- توضیحات: در بخش توضیحات حتما شرح دقیق ارائه شود (اگر توضیحات نوشته می شود) اگر توضیحات زیاد است. در یک فایل نوشته شود و در قسمت توضیحات به آن اشاره شود.
- footer:
در بخش فوتر برخی اطلاعات خاص در مورد commit داده می شود که در واقع توجه خاص برای مثال:
BREAKING CHANGE: این مورد در فوتر به عنوان یک توضیحات آورده شود. همناطور که از عنوان هم مشخص است در صورتی که یک تغییر اساسی در پروژه و فایل انجام می شود این مورد باید حتما اضافه شود.