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

[Feature Request] Implementation of Changelog Entries #1096

Open
sanvviratthore opened this issue Oct 3, 2024 · 3 comments
Open

[Feature Request] Implementation of Changelog Entries #1096

sanvviratthore opened this issue Oct 3, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@sanvviratthore
Copy link

The current CHANGELOG-TEMPLATE.md file is empty and lacks any entries. To improve project documentation and user awareness of changes, I suggest we start populating the changelog with past releases and updates.

Moreover, having a standardized format for documenting changes will help maintain consistency and clarity. Could we establish guidelines for contributors on how to fill out this template?

@sanvviratthore sanvviratthore added the enhancement New feature or request label Oct 3, 2024
@Robonau
Copy link
Contributor

Robonau commented Oct 3, 2024

given its practically never been used (and has never been used by any of the current devs), a more realistic solution is deleting it

@sanvviratthore
Copy link
Author

I understand the reasoning behind deleting the changelog template, especially if it hasn't been used. However, I believe having a changelog could still be beneficial for future reference and for new contributors. If the team agrees, perhaps we can consider establishing guidelines on its use before deciding to remove it.

@Syer10
Copy link
Collaborator

Syer10 commented Oct 3, 2024

We already have a history of changes inside CHANGELOG.md. The changelog template is for us to copy and edit for CHANGELOG.md when we are making a release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants