Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a CHANGELOG.md #23

Open
tannerjones4075 opened this issue Jan 11, 2024 · 0 comments
Open

Create a CHANGELOG.md #23

tannerjones4075 opened this issue Jan 11, 2024 · 0 comments

Comments

@tannerjones4075
Copy link
Contributor

tannerjones4075 commented Jan 11, 2024

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.

@tannerjones4075 tannerjones4075 changed the title Create a CHANGELOG.md Create a CHANGELOG.md Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant