فهرست تغییرها
هر نسخهی تازه یک فهرست تغییر (changelog) دارد با چند عنوان ثابت. اگر این عنوانها را بشناسی، در یک دقیقه میفهمی upgrade برایت بیخطر است یا نه.
ed بدون فاعل، و صفت تفضیلی
جملههای changelog با شکل ed فعل شروع میشوند و فاعل ندارند: «Fixed a crash» یعنی «(ما) یک کرش را درست کردیم» و «Added dark mode» یعنی «حالت تاریک اضافه شد». ed سه جور خوانده میشود: «د» در changed، «ت» در fixed و «اِد» در added. بهترشدنها هم با er میآیند: faster (سریعتر)، smaller (کوچکتر)، و برای صفتهای بلند با more: more stable.
هشت کلمهی این درس
added (اَدِد): اضافه شد
added شکل گذشته و سومِ add است: «اضافهشده». در changelog عنوان بخشی است که چیزهای تازهی یک نسخه را فهرست میکند: قابلیت نو، گزینهی نو، فایل نو. جملهها کوتاه و بدون فاعلاند: «Added dark mode» یعنی «حالت تاریک اضافه شد». در مستندات هم «Added in version 3.9» یعنی از نسخهی ۳٫۹ وجود دارد.
Added a dark mode option to the settings page.
یک گزینهی حالت تاریک به صفحهی تنظیمات اضافه شد.
changed (چِینجد): تغییر کرد
changed یعنی «تغییرکرده». در changelog بخشی است برای چیزهایی که از قبل بودند ولی حالا جور دیگری کار میکنند: پیشفرض تازه، ظاهر تازه، اسم تازه. این بخش را قبل از upgrade با دقت بخوان، چون ممکن است رفتار برنامهی تو هم عوض شود.
Changed the default timeout from 30 to 60 seconds.
مهلت پیشفرض از ۳۰ به ۶۰ ثانیه تغییر کرد.
fixed (فیکست): درست شد؛ رفع شد
fixed شکل گذشتهی fix است: «درستشده». در changelog بخش Fixed باگهایی را فهرست میکند که در این نسخه رفع شدهاند. اگر به باگی خوردهای، اول اینجا را نگاه کن؛ شاید با یک upgrade ساده حل شود. در پیام commit هم زیاد میآید.
Fixed a crash that happened when the file was empty.
کرشی که هنگام خالی بودن فایل رخ میداد رفع شد.
removed (ریمووْد): حذف شد
removed یعنی «برداشتهشده». در changelog بخش Removed چیزهایی را میگوید که دیگر در این نسخه نیستند: یک تابع قدیمی، یک گزینه، پشتیبانی از یک نسخهی کهنه. معمولاً اول چیزی deprecated میشود (هشدار میدهد) و چند نسخه بعد removed. اگر کد تو از آن استفاده میکرد، بعد از upgrade خطا میگیری.
Removed support for Python 3.7.
پشتیبانی از پایتون ۳٫۷ برداشته شد.
improved (ایمپرووْد): بهتر شد
improve یعنی «بهتر کردن» و improved یعنی «بهترشده». در changelog وقتی میآید که چیز تازهای اضافه نشده و باگی هم در کار نبوده، فقط همان چیز قبلی حالا سریعتر، روشنتر یا راحتتر شده است: «Improved performance»، «Improved error messages».
Improved the loading speed of the home page.
سرعت بارگذاری صفحهی اصلی بهتر شد.
breaking change (بِرِیکینگ چِینج): تغییری که کدهای قبلی را خراب میکند
break یعنی «شکستن». breaking change تغییری در یک کتابخانه یا API است که کدهای نوشتهشده برای نسخهی قبل را میشکند: اسم تابعی عوض شده، پارامتری برداشته شده یا خروجی شکل دیگری گرفته است. بعد از upgrade باید کد خودت را هم عوض کنی. برای همین در changelog آن را پررنگ مینویسند و معمولاً شمارهی اول نسخه بالا میرود (از 1.x به 2.0).
Version 2.0 has one breaking change: the config file format.
نسخهی ۲٫۰ یک تغییر شکننده دارد: قالب فایل تنظیمات.
bug fix (باگ فیکس): رفع باگ
bug یعنی ایراد برنامه و fix یعنی درست کردن. bug fix تغییری است که فقط یک ایراد را رفع میکند و چیز تازهای اضافه نمیکند. نسخههایی که فقط bug fix دارند معمولاً فقط شمارهی آخرشان بالا میرود (از 2.3.1 به 2.3.2) و نصبشان بیخطر است.
This release contains only bug fixes and no new features.
این انتشار فقط رفع باگ دارد و هیچ قابلیت تازهای ندارد.
feature (فیچِر): قابلیت؛ امکان
feature یعنی یک توانایی مشخص از یک برنامه: جستوجو، حالت تاریک، ورود با ایمیل. هر چیزی که کاربر میتواند با برنامه انجام دهد یک feature است. در changelog و سایتها فهرست Features را میبینی و در تیمها میشنوی «I am working on a new feature».
The new version adds a search feature to the app.
نسخهی تازه یک قابلیت جستوجو به برنامه اضافه میکند.
یک changelog واقعی
## [3.0.0] - 2025-03-02
### Breaking change
- load() now returns a dictionary instead of a list.
### Added
- New feature: export your notes as PDF.
### Changed
- The default theme is now dark.
### Improved
- Search is twice as fast.
### Fixed
- Bug fix: the app no longer crashes on empty files.
### Removed
- Support for Python 3.7.
## [3.0.0] - 2025-03-02
### تغییر شکننده
- load() حالا بهجای فهرست یک دیکشنری برمیگرداند.
### اضافه شد
- قابلیت تازه: یادداشتهایت را به شکل PDF خروجی بگیر.
### تغییر کرد
- پوستهی پیشفرض حالا تاریک است.
### بهتر شد
- جستوجو دو برابر سریعتر شده است.
### رفع شد
- رفع باگ: برنامه دیگر با فایلهای خالی کرش نمیکند.
### حذف شد
- پشتیبانی از پایتون ۳٫۷.