Create a CHANGELOG.md #23
Description
I can help with this, if it is something that wants to be implemented.
Description:
Implementing a Changelog for the project to document changes made over time.
Motivation:
The motivation behind this feature is to improve communication with users and contributors. Currently, there isn't a centralized and organized way to convey information about changes, releases, and bug fixes. Introducing a Changelog will enhance transparency, making it easier for users to stay informed about updates and understand the evolution of the project.
Proposed Solution:
Introduce a Changelog file within the project repository. The Changelog will follow a standardized format and will be updated with each release. It will include sections such as Added, Changed, Deprecated, Removed, Fixed, and Security, providing a clear overview of modifications made in each version. See here.
Enforcement:
Verify the changelog when pushing to repository, see here for an example.
Enhanced Reporting:
The Changelog will be utilized for creating detailed release notes with each new version. This will involve summarizing the changes made in a human-readable format, making it easy for users to understand what to expect in each release.
Documentation Updates:
The implementation of the Changelog will require updates to the project's documentation. We will add a section to the README or CONTRIBUTING file explaining how users and contributors can access the Changelog.