در هنگام کامیت گذاری فایل README.md در گیت، معمولاً از پیامهای مصطلح و رایج زیر استفاده میشود.
در اینجا چند پیام کامیت متداول برای فایل README آورده شده است:
1. “Add README file”
ترجمه: “اضافه کردن فایل README”
این پیام برای زمانی استفاده میشود که فایل README.md برای اولین بار به مخزن اضافه میشود.
2. “Initial commit with README”
ترجمه: “کامیت اولیه با فایل README”
معمولاً هنگام ایجاد یک مخزن جدید و اضافه کردن فایل README.md در ابتدا از این پیام استفاده میشود.
3. “Create README.md”
ترجمه: “ایجاد فایل README.md”
این پیام برای زمانی است که فایل README.md ایجاد شده است.
4. “Update README”
ترجمه: “بهروزرسانی فایل README”
این پیام برای زمانی است که شما محتوای فایل README.md را ویرایش کردهاید.
5. “Fix typo in README”
ترجمه: “اصلاح اشتباه تایپی در فایل README”
وقتی یک اشتباه تایپی یا غلط املایی در فایل README.md پیدا و اصلاح میشود.
6. “Improve README content”
ترجمه: “بهبود محتوای فایل README”
وقتی شما محتوا یا توضیحات فایل README.md را اصلاح یا بهبود میدهید.
7. “Add project description to README”
ترجمه: “اضافه کردن توضیحات پروژه به فایل README”
زمانی که توضیحات پروژه به فایل README.md افزوده میشود.
8. “Update installation instructions in README”
ترجمه: “بهروزرسانی دستورالعملهای نصب در فایل README”
وقتی دستورالعملهای نصب یا راهاندازی پروژه در فایل README.md تغییر میکند.
9. “Add badges to README”
ترجمه: “اضافه کردن نشانها (Badges) به فایل README”
زمانی که شما نشانها (مثل وضعیت ساخت، پوشش تستها و غیره) را به فایل README.md اضافه میکنید.
10. “Rewrite README for clarity”
ترجمه: “بازنویسی فایل README برای وضوح بیشتر”
وقتی محتوای فایل README.md برای روشنتر و مفهومیتر شدن بازنویسی میشود.
نکته:
این پیامها معمولاً مختصر و مرتبط با تغییراتی هستند که در فایل README.md ایجاد میشوند. همیشه بهتر است پیامهای کامیت واضح و معنیدار باشند تا دیگران (و یا خودتان در آینده) بتوانند به راحتی متوجه تغییرات شوند.