در گیت، برای انجام کامیت (commit)، استفاده از پیام‌های واضح و معنی‌دار بسیار مهم است. چون باعث می شود تاریخچه شفاف تر و قابل فهم تر شود و همچنین باعث افزایش بهره وری، راحتی در همکاری تیمی و تسهیل در فرآیند های مستند سازی خواهد شد.
این کار باعث ایجاد نظم و ساختار در پروژه می شود و در بلند مدت از سردرگمی و مشکلات ناشی از استفاده از پپام های نا مفهوم جلوگیری خواهد کرد.
در اینجا تعدادی از عبارات متداول برای پیام‌های کامیت به زبان انگلیسی همراه با ترجمه فارسی آورده شده است
1. “Initial commit”
ترجمه فارسی: “کامیت اولیه”
توضیح: این پیام زمانی استفاده می‌شود که اولین بار در مخزن گیت پروژه خود را کامیت می‌کنید.
2. “Add file-name”
ترجمه فارسی: “افزودن <نام فایل>”
توضیح: برای اضافه کردن یک فایل جدید به پروژه، از این پیام استفاده می‌شود.
مثال: Add README.md
3. “Update file-name”
ترجمه فارسی: “به‌روزرسانی <نام فایل>”
توضیح: زمانی که تغییراتی در فایل موجود ایجاد می‌کنید، این پیام استفاده می‌شود.
مثال: Update styles.css
4. “Fix issue/bug”
ترجمه فارسی: “رفع <مشکل/باگ>”
توضیح: برای کامیت‌هایی که مربوط به رفع باگ‌ها یا مشکلات شناخته شده هستند.
مثال: Fix navbar layout bug
5. “Refactor code/feature”
ترجمه فارسی: “بازسازی <کد/ویژگی>”
توضیح: این پیام برای تغییرات مربوط به بهبود کد یا ویژگی‌های موجود بدون تغییر در عملکرد استفاده می‌شود.
مثال: Refactor authentication logic
6. “Remove file/feature”
ترجمه فارسی: “حذف <فایل/ویژگی>”
توضیح: برای حذف یک فایل یا ویژگی از پروژه.
مثال: Remove unused images
7. “Add feature feature-name”
ترجمه فارسی: “افزودن ویژگی <نام ویژگی>”
توضیح: وقتی یک ویژگی جدید به پروژه اضافه می‌شود.
مثال: Add feature login page
8. “Improve feature/functionality”
ترجمه فارسی: “بهبود <ویژگی/عملکرد>”
توضیح: زمانی که تغییراتی برای بهبود ویژگی یا عملکردی در پروژه اعمال می‌شود.
مثال: Improve search functionality
9. “Fix typo in file-name”
ترجمه فارسی: “اصلاح اشتباه تایپی در <نام فایل>”
توضیح: برای اصلاح اشتباهات تایپی در کد یا مستندات.
مثال: Fix typo in README.md
10. “Revert commit-hash”
ترجمه فارسی: “برگشت به <هش کامیت>”
توضیح: زمانی که قصد دارید تغییرات یک کامیت خاص را به حالت قبل برگردانید.
مثال: Revert 2d34b5f
11. “Merge branch ‘branch-name'”
ترجمه فارسی: “ادغام شاخه ‘<نام شاخه>'”
توضیح: برای ادغام یک شاخه به شاخه اصلی (معمولاً master یا main).
مثال: Merge branch ‘feature/login-page’
12. “Create <branch-name> branch”
ترجمه فارسی: “ایجاد شاخه <نام شاخه>”
توضیح: برای ایجاد یک شاخه جدید در گیت.
مثال: Create feature/login-page branch
13. “Update dependencies”
ترجمه فارسی: “به‌روزرسانی وابستگی‌ها”
توضیح: زمانی که وابستگی‌های پروژه (مانند پکیج‌ها یا کتابخانه‌ها) به‌روزرسانی می‌شوند.
مثال: Update dependencies
14. “Add tests for feature”
ترجمه فارسی: “افزودن تست‌ها برای <ویژگی>”
توضیح: زمانی که تست‌هایی برای یک ویژگی جدید اضافه می‌شود.
مثال: Add tests for login functionality
15. “Improve performance”
ترجمه فارسی: “بهبود عملکرد”
توضیح: زمانی که تغییری برای بهبود عملکرد سیستم اعمال می‌شود.
مثال: Improve performance of search queries
16. “Document feature/file”
ترجمه فارسی: “مستندسازی <ویژگی/فایل>”
توضیح: زمانی که مستندات پروژه به روز یا اضافه می‌شوند.
مثال: Document API endpoints
17. “Upgrade dependency”
ترجمه فارسی: “ارتقاء <وابستگی>”
توضیح: برای ارتقاء نسخه یک وابستگی (مانند پکیج یا کتابخانه).
مثال: Upgrade React to version 18
18. “Add <feature> to file”
ترجمه فارسی: “افزودن <ویژگی> به <فایل>”
توضیح: زمانی که ویژگی یا قابلیت جدیدی به یک فایل خاص اضافه می‌شود.
مثال: Add validation to form.js
19. “Cleanup file”
ترجمه فارسی: “تمیزکاری <فایل>”
توضیح: برای حذف کدهای زائد یا اصلاح کد در یک فایل.
مثال: Cleanup unused variables in app.js
20. “Optimize feature”
ترجمه فارسی: “بهینه‌سازی <ویژگی>”
توضیح: زمانی که تغییراتی برای بهینه‌سازی عملکرد یک ویژگی انجام می‌شود.
مثال: Optimize image loading
نکات برای نوشتن پیام‌های کامیت:
کوتاه و مختصر باشد: پیام کامیت باید در یک خط کوتاه و شفاف توضیح دهد که چه تغییراتی ایجاد شده است.
استفاده از زمان حال: برای توصیف تغییرات از زمان حال (present tense) استفاده کنید. مثلاً “Fix bug” به جای “Fixed bug”.
جزئیات کافی برای دیگران: پیام باید به اندازه کافی توضیح دهد که دیگران بتوانند بفهمند چرا و چگونه تغییرات انجام شده است.
با استفاده از این پیام‌های کامیت، می‌توانید تاریخچه کامیت‌های پروژه خود را به صورت مرتب، واضح و قابل فهم نگه دارید.