Changelog conventions
Every add-on has a Changelog page in this documentation, built from the CHANGELOG.md that ships with the add-on. Here is how to read it.
Versioning
Section titled “Versioning”We use Semantic Versioning. Versions look like MAJOR.MINOR.PATCH, and the same number appears in Add-ons → Manage add-ons.
| Change | Example | What it means for you |
|---|---|---|
| Patch | 1.2.3 → 1.2.4 | Bug fixes only. Safe to install right away. |
| Minor | 1.2.4 → 1.3.0 | New features or settings, backwards-compatible. Existing settings are kept. |
| Major | 1.3.0 → 2.0.0 | Breaking changes, such as a new minimum CS-Cart version, removed settings or changed template hooks. Read the Upgrade notes first. |
Format
Section titled “Format”Changelogs follow Keep a Changelog. The newest version is at the top. Each release has a date in ISO format and changes grouped under these headings:
- Added: new features
- Changed: changes to existing behaviour
- Deprecated: features that will be removed in a future release
- Removed: features removed in this release
- Fixed: bug fixes
- Security: fixes for vulnerabilities. We recommend updating promptly.
Releases that need action from you also have an Upgrade notes section.
Example
Section titled “Example”## [1.3.0] - 2026-11-02
### Added- Per-vendor threshold override in the vendor panel (Multi-Vendor).
### Fixed- Progress bar didn't update after removing a product from the mini-cart.
### Upgrade notes- If you customised `views/checkout/components/progress_bar.tpl` in your theme, merge the new `data-kv-*` attributes into your copy.Compatibility notes in releases
Section titled “Compatibility notes in releases”If a release changes the supported CS-Cart or PHP versions, the changelog says so under Changed, and under Upgrade notes when it matters for existing installs. See the compatibility policy.