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

1. ‫چطور‬‫در‬Git‫توضیح‬
‫بنویسیم‬
‫اینکه‬‫چرا‬‫باید‬‫اصال‬‫توضیح‬،‫بنویسیم‬‫چونکه‬‫ر‬‫عایت‬
‫کردن‬‫یکسری‬‫استاندارد‬‫بین‬‫افراد‬‫یک‬‫پروژه‬‫می‬‫ت‬‫واند‬
‫روند‬‫کارها‬‫را‬‫سریعتر‬‫و‬‫اشتباهات‬‫را‬‫کاهش‬‫دهد‬.‫یکی‬
‫از‬‫همین‬‫استانداردها‬‫قوانینی‬‫است‬‫که‬‫برای‬‫نوشتن‬
‫توضیحات‬‫در‬‫گیت‬‫می‬‫باشد‬.
‫بهتر‬‫است‬‫حداقل‬‫سه‬‫چیز‬‫رعایت‬‫شود‬:
1.‫سبک‬‫نگارش‬‫است‬‫بهتر‬Commit‫تا‬‫جای‬‫ممکن‬،‫ساده‬‫مختصر‬‫و‬‫مفید‬‫نوشته‬‫شود‬‫که‬‫در‬‫آینده‬‫در‬‫صورت‬
‫مشاهده‬‫آن‬‫بتوان‬‫براحتی‬‫محتویات‬‫و‬‫موضوع‬‫آن‬‫را‬‫فهمید‬.‫همچنین‬‫طول‬‫خط‬‫به‬۵۰‫کاراکتر‬‫محدود‬‫شود‬
‫تا‬‫نیازی‬‫به‬‫اسکرول‬‫افقی‬‫نباشد‬.
2.‫محتوا‬‫پاسخ‬‫به‬”‫چرا‬”‫و‬‫نه‬”‫چطور‬“.‫بطور‬‫مثال‬‫نگوییم‬‫فانکشن‬xxx‫اضافه‬،‫شد‬‫بگوییم‬”‫حل‬‫مشکل‬
‫نمایش‬‫کاربران‬ ‫فهرست‬”،‫البته‬‫بعضی‬‫اوقات‬‫بهتره‬‫که‬‫عنوان‬‫تسک‬‫یا‬‫همان‬‫صورت‬‫مسئله‬‫را‬‫بنوی‬‫سم‬.
3.‫داده‬‫های‬‫کلیدی‬
•‫استفاده‬‫از‬‫کد‬‫تسک‬:‫شماره‬‫تسک‬‫مرتبط‬‫با‬Commit‫در‬‫پیام‬‫تا‬‫حد‬‫زیادی‬‫ابهامات‬‫احتمالی‬‫را‬
‫برطرف‬‫خواهد‬‫کرد‬‫بنابراین‬‫بهتره‬‫مثالبا‬‫استفاده‬‫از‬‫هشتگ‬#‫شماره‬‫تسک‬‫را‬‫مشخص‬.‫کنیم‬
Fix: Do not show users list #77
•‫استفاده‬‫از‬‫کلمات‬‫کلیدی‬:‫می‬‫توانیم‬‫برای‬‫هر‬‫پروژه‬‫کلماتی‬‫برای‬‫شروع‬‫پیام‬‫مشخص‬‫کنیم‬:
oNew‫اگر‬‫محتوا‬‫در‬‫رابطه‬‫با‬‫افزودن‬‫قابلیت‬‫ویا‬‫بخش‬‫جدیدی‬‫به‬‫محصول‬‫است‬.
oUpdate‫اگر‬‫محتوا‬‫در‬‫رابطه‬‫با‬‫اصالح‬‫قابلیت‬‫یا‬‫بهبود‬‫بخشی‬‫که‬‫وجود‬‫دارد‬‫است‬.
oFix‫اگر‬‫محتوا‬‫شامل‬‫رفع‬‫اشکال‬‫در‬‫بخشی‬‫از‬‫محصول‬‫است‬.
o‫و‬...