Planet RoadmapTemplates
Releases
Changelog Template
Maintain a clear, human-readable record of every change made to your project. Use this structured format to communicate updates to users and internal stakeholders.
When to use this template
- •When you need to communicate new feature releases and bug fixes to your user base.
- •When internal teams need a central source of truth for version history and project evolution.
- •When preparing for a major version launch and you need to document deprecated or removed functionality.
How to fill it in
- 1.List all recent changes under the [Unreleased] section as they happen in development.
- 2.When ready to release, move [Unreleased] items to a new version heading with the current date.
- 3.Categorize each change using standard labels like Added, Changed, Fixed, or Security.
- 4.Link to specific pull requests or issue tickets for technical depth where necessary.
Template preview
[1.2.0] — 2026-05-07
- ·Added: Real-time Gantt chart synchronization.
- ·Added: OKR progress auto-calculation from subtasks.
- ·Fixed: Race condition in the Kanban drag-and-drop handler.
- ·Changed: Updated the sidebar navigation for better mobile accessibility.
[1.1.5] — 2026-04-20
- ·Fixed: Memory leak when viewing large project tables.
- ·Fixed: Incorrect timezone offset in the Calendar view.
- ·Security: Patched a vulnerability in the file upload middleware.
- ·Added: Support for Portuguese and Spanish localizations.
[1.1.0] — 2026-03-15
- ·Added: Public roadmap portal with voting capabilities.
- ·Changed: Redesigned the user profile settings page.
- ·Deprecated: Legacy API v1 endpoints (to be removed in v2.0.0).
- ·Removed: Support for Internet Explorer 11.
Copy as Markdown
# Changelog All notable changes to [Project Name] will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ### Added - [New feature description] ### Changed - [Modified functionality description] ### Fixed - [Bug fix description] ## [1.1.0] - 2026-05-07 ### Added - Multi-factor authentication support for all user roles. - Export to CSV functionality for the project dashboard. ### Fixed - Navigation menu layout on tablets. - Intermittent API timeout when fetching large datasets. ## [1.0.1] - 2026-04-22 ### Changed - Improved search algorithm performance by 30%. - Updated the logo to the high-resolution SVG version. ### Security - Upgraded dependency `lodash` to v4.17.21 to address security vulnerability. ## [1.0.0] - 2026-04-01 ### Added - Initial release of the [Project Name] core application. - User authentication and profile management. - Basic project tracking and task assignment. --- Template provided by [Planet Roadmap](https://planetroadmap.com).
Sync your changelog directly with Planet Roadmap's public roadmap to keep your users informed as soon as a feature moves to 'Done'.
Skip copy-paste. Set up this template inside a Planet Roadmap project in one click.
FAQ
Why should I use a changelog instead of just a git log?
Git logs are for developers; changelogs are for humans. A changelog summarizes the 'why' and 'what' without the noise of individual commit messages.
What belongs in the 'Changed' section versus 'Added'?
'Added' is for entirely new functionality. 'Changed' is for modifications to existing features, such as UI updates or logic improvements.
How often should I update the [Unreleased] section?
Update it every time a pull request is merged to ensure no changes are forgotten when the next release window arrives.
Should I include technical jargon in my public changelog?
Keep it accessible for your users. If a technical detail is critical, link to a technical documentation page or the specific GitHub issue.