Skip to main content

Documentation Changelog

Changelog policy

The changelog is the release narrative for engineers, QA, and non-technical stakeholders.

Recommended entry format

  • Date and version/tag.
  • Feature changes.
  • Bug fixes.
  • Internal/technical updates with visible impact.

Writing rule

Describe business and technical impact clearly instead of pasting raw commit lists.

Team habit

Update changelog in the same PR as the feature/change to preserve accurate history.