پیام ها را متعهد کنید
پاک کردن پیام‌های commit بررسی درخواست‌های کششی را آسان‌تر می‌کند و ایجاد یادداشت‌ها را آسان‌تر می‌کند. پروژه Blockly از تعهدات مرسوم برای کمک به این امر استفاده می کند.
هر کامیت باید فرمت زیر را داشته باشد:
<type>: <description>
[optional body]
[optional footer(s)]
توجه داشته باشید که مخزن اصلی Blockly دارای یک commit linter برای کمک به اجرای این امر است. اگر درخواست pull شما دارای چندین commit باشد، لینتر عنوان را بررسی می کند. اگر یک commit داشته باشد، آن commit را بررسی می کند. بهتر است هر دو commit های فردی و عنوان درخواست کشش از این دستورالعمل ها پیروی کنند.
تایپ کنید
نوع باید غیر خالی و تمام حروف کوچک باشد. در زیر لیستی از انواع پذیرفته شده است.
- کارهای عادی و روزمره
- برای تعهداتی که وظایف روتین/اتوماتیکی مانند ارتقاء وابستگی ها را کامل می کنند.
- منسوخ کردن
- برای تعهداتی که عملکرد را از بین می برند.
- شاهکار
- برای commit هایی که قابلیت جدیدی به Blockly اضافه می کنند.
- ثابت
- برای commit هایی که باگ ها/خطاها را در Blockly رفع می کنند.
- رهایی
- برای تعهدات مربوط به انتشار نسخه جدید.
شکستن تغییرات
تعهداتی که تغییرات اساسی ایجاد می کنند باید یک ضمیمه کنند ! بعد از نوع تعهد تغییرات شکسته، تغییراتی هستند که ممکن است توسعه دهندگان را که از Blockly در برنامه هایشان استفاده می کنند، شکسته و باعث شود آنها مجبور به انجام کارهای اضافی شوند.
به عنوان مثال: fix!: return type of workspace.paste
شکستن تغییرات می تواند هر یک از انواع معتبر بالا را داشته باشد.
شرح
توضیحات باید خالی نباشد و کمتر از 256 کاراکتر باشد.
بدن
بدنه اختیاری است. در صورت ارائه باید یک خط خالی بین آن و توضیحات وجود داشته باشد. باید به خطوطی با حداکثر 256 کاراکتر تقسیم شود.
توجه داشته باشید که معمولاً توصیه می‌شود این نوع اطلاعات را علاوه بر/به‌جای اینکه مستقیماً در commit قرار دهید، در توضیحات درخواست کشش خود قرار دهید.
پاورقی
پاورقی اختیاری است. در صورت ارائه باید یک خط خالی بین آن و بدنه وجود داشته باشد. باید به خطوطی با حداکثر 256 کاراکتر تقسیم شود.
رفع تعهدات غیر متعارف
اگر هنگام انجام تغییرات از commit های معمولی استفاده نکردید، بسته به تعداد commit هایی که دارید، دو گزینه برای رفع پیام ها وجود دارد:
اگر درخواست pull شما دارای چندین تعهد است، عنوان درخواست کشش را برای مطابقت با الزامات ویرایش کنید. هنگامی که درخواست کشش ادغام شد، سایر commit های شما له می شوند تا عنوان به پیام commit تبدیل شود.
اگر درخواست pull شما یک commit دارد، پیام commit خود را با استفاده از
git commit --amendاصلاح کنید، سپس تغییرات خود را مجبور کنید به فورک Blockly خود فشار دهید. این به طور خودکار هر درخواست کشش باز مرتبط با این شاخه را به روز می کند.git push --force origin my-branch.