پیام commit
تاریخچهی گیت دفتر خاطرات پروژه است و هر پیام commit یک خط از آن. با این کلمهها پیامهایی مینویسی که شش ماه بعد هم معنی بدهند.
فعل امری در پیام commit
پیام commit را مثل یک دستور مینویسند: «Fix login bug»، «Add search page»، «Remove old tests». نه «Fixed» (گذشته)، نه «Fixes» و نه «I fixed». راه امتحانش: پیام باید این جمله را کامل کند: «If applied, this commit will ___». حرف اول بزرگ است و آخر خط نقطه نمیگذارند.
هشت کلمهی این درس
commit message (کامیت مِسِج): پیام کوتاهی که میگوید این commit چه کرده
هر بار که در گیت commit میکنی، باید یک message (پیام) هم بنویسی که بگوید چه چیزی عوض شد. رسمش این است: خط اول کوتاه (حدود ۵۰ حرف)، با فعل امری و حرف اول بزرگ، بدون نقطه در آخر: «Fix login bug»، نه «Fixed» و نه «I fixed». اگر توضیح بیشتری لازم است، یک خط خالی بگذار و بعد دلیل کار را بنویس.
Write a short commit message that says what the change does.
یک پیام commit کوتاه بنویس که بگوید این تغییر چه کار میکند.
implement (ایمپلِمِنت): پیادهسازی کردن؛ یک ایده را به کد تبدیل کردن
implement یعنی یک نقشه یا ایده را واقعاً اجرا کردن. در برنامهنویسی یعنی چیزی که فقط روی کاغذ یا در ذهن بود را به کدِ کارکننده تبدیل کنی. در پیام commit وقتی آن را به کار میبرند که یک قابلیت کامل ساخته شده باشد، نه یک تغییر کوچک. اسمش implementation است: «پیادهسازی».
This commit implements search by username.
این commit جستوجو با نام کاربری را پیادهسازی میکند.
refactor (ریفَکتور): مرتب کردن کد بدون عوض کردن کاری که میکند
refactor یعنی ساختار کد را بهتر کنی (اسمهای بهتر، تابعهای کوچکتر، تکرار کمتر) بدون اینکه رفتار برنامه عوض شود. مثل مرتب کردن اتاق: همان وسایل هست، فقط هر چیز سر جای درستش میرود. وقتی در پیام commit مینویسی Refactor، به بازبین قول میدهی که هیچ قابلیتی اضافه یا کم نشده است.
I refactored the checkout code, but the behavior is the same.
کد پرداخت را مرتب کردم، ولی رفتارش همان است.
cleanup (کلینآپ): پاکسازی، جمعوجور کردن
clean up یعنی تمیز و جمعوجور کردن، مثل جمع کردن میز بعد از کار. در کد، cleanup یعنی دور ریختن چیزهای اضافه: importهای بیاستفاده، printهای آزمایشی، فایلهای موقت، کد مرده. از refactor کوچکتر و سادهتر است. به کدی هم که آخر کار منابع را آزاد میکند (بستن فایل یا اتصال) cleanup میگویند.
This is only a small cleanup, no behavior has changed.
این فقط یک پاکسازی کوچک است؛ هیچ رفتاری عوض نشده.
bump (بامپ): بالا بردن شمارهی نسخه
bump در انگلیسی یعنی ضربهی کوچک یا تکان دادن چیزی به بالا. در پیام commit یعنی شمارهی نسخه را یک پله بالا بردی: نسخهی خود پروژه یا نسخهی یکی از کتابخانههایی که به آن وابستهای. این commitها معمولاً فقط یکی دو خط در فایل تنظیمات را عوض میکنند.
I bumped the version to 2.1.0 before the release.
قبل از انتشار، نسخه را به 2.1.0 بالا بردم.
initial commit (اینیشِل کامیت): اولین commit یک پروژه
initial یعنی «آغازین» یا «اولیه» (از همان ریشهی initialize). initial commit اولین commit یک مخزن است؛ همان لحظهای که پروژه به دنیا میآید. اینقدر رسم است که تقریباً همه پیام اولین commit را همین دو کلمه مینویسند و اگر تاریخچهی یک پروژه را تا ته بروی، معمولاً به آن میرسی.
The repository has only one commit: the initial commit.
این مخزن فقط یک commit دارد: همان commit اول.
minor (مایْنِر): کوچک، جزئی، کماهمیت
minor یعنی کوچک و کماهمیت: a minor change یعنی تغییری که چیز مهمی را عوض نمیکند. در شمارهی نسخه (مثلاً 2.4.1) عدد وسط را minor version میگویند: وقتی بالا میرود یعنی قابلیت تازه آمده ولی کد قبلی تو هنوز کار میکند. در پیام commit و بازبینی هم زیاد میبینی: Minor fixes، a minor issue.
This is a minor change, it only fixes two typos.
این یک تغییر جزئی است؛ فقط دو غلط تایپی را درست میکند.
major (مِیجِر): بزرگ، اساسی، مهم
major یعنی بزرگ و مهم: a major bug باگی است که کار اصلی برنامه را خراب میکند. در شمارهی نسخه، عدد اول major version است: وقتی از ۲ به ۳ میرود یعنی تغییرهای اساسی آمده و شاید کد قبلی تو بدون تغییر کار نکند (breaking change). برای همین قبل از بالا بردن نسخهی major، راهنمای مهاجرت را بخوان.
Version 3.0 is a major release with several breaking changes.
نسخهی 3.0 یک انتشار بزرگ با چند تغییر ناسازگار است.
تاریخچهی یک پروژه
$ git log --oneline
9c1e2aa Bump version to 2.0.0
51b7d03 Implement dark mode
3f9a6c2 Refactor settings page into components
8d4e1b7 Clean up unused styles
2a6f0c9 Fix minor typo in README
1e0b5d4 Initial commit
Every commit message here starts with a verb and is under 50 letters. Version 2.0.0 is a major release because dark mode changes the theme files. The cleanup and the refactor do not change how the app works.
$ git log --oneline
9c1e2aa نسخه را به 2.0.0 بالا ببر
51b7d03 حالت تاریک را پیادهسازی کن
3f9a6c2 صفحهی تنظیمات را به چند کامپوننت بازسازی کن
8d4e1b7 استایلهای بیاستفاده را پاک کن
2a6f0c9 یک غلط تایپی جزئی را در README درست کن
1e0b5d4 اولین commit
هر پیام commit در اینجا با یک فعل شروع میشود و کمتر از ۵۰ حرف است. نسخهی 2.0.0 یک انتشار بزرگ است، چون حالت تاریک فایلهای پوسته را عوض میکند. پاکسازی و بازسازی، طرز کار برنامه را عوض نمیکنند.