📋 Reading: Release Notes & Changelogs
3 exercises — read a realistic CHANGELOG.md covering two versions. Extract what changed, what was fixed, what's deprecated, and understand Semantic Versioning.
Keep a Changelog section types
- Added → new features (safe to ignore if you don't need them)
- Changed → existing behavior changed — READ CAREFULLY for breaking impact
- Deprecated → still works, but start migrating now
- Removed → gone — check if your code used this
- Fixed → bugs resolved
- Security → vulnerability patches — always apply urgently
0 / 3 completed
1 / 3
CHANGELOG.md
{ex.passage}A developer is using GET /api/v1/users in their integration. According to version 2.4.0, what changed about this endpoint?
The page size was reduced from 50 to 20 results per page:
Under the
This is a breaking behavior change: even though the endpoint wasn't removed, a developer who assumed pages had 50 items could now see truncated results, broken pagination, or fewer records than expected without an error.
It's the
Changelog section vocabulary (Keep a Changelog format):
Under the
### Changed section of v2.4.0: "/api/v1/users now returns 20 results per page (was 50) to improve performance".This is a breaking behavior change: even though the endpoint wasn't removed, a developer who assumed pages had 50 items could now see truncated results, broken pagination, or fewer records than expected without an error.
It's the
### Deprecated section that handles removal notices: the deprecated item is GET /api/v1/legacy/export (not users), which will be removed in v3.0.0.Changelog section vocabulary (Keep a Changelog format):
- Added → new features or endpoints
- Changed → changes to existing functionality that may affect users
- Deprecated → features marked for future removal (still works, but start migrating)
- Removed → features that no longer exist
- Fixed → bug fixes
- Security → vulnerability patches