Skip to content

Add a Semantic Versioning Changelog to the RepositoryΒ #689

@bhimrazy

Description

@bhimrazy

πŸš€ Feature

Title: Add a Semantic Versioning Changelog to the Repository

Description:

To improve project transparency and ease of tracking changes, we should add a dedicated CHANGELOG.md file following the Keep a Changelog standard with semantic versioning.

Motivation:

  • A well-maintained changelog helps contributors and users quickly understand what has changed in each release.
  • It documents notable features, bug fixes, and improvements in an organized manner.
  • It would also help us include updates in release notes in a better and more consistent way.
  • It enhances project maintainability and communication.

Suggested Structure:

# Changelog

All notable changes to this project will be documented in this file.

## [Unreleased]

## [1.0.0] - YYYY-MM-DD
### Added
- Initial release

Refs:

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions