Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #259.
Proposal
Description:
As our project continues to grow and evolve, it's becoming increasingly important that we keep a comprehensive record of all changes that have occurred in each new version. This will allow both the team and our users to track the evolution of the project easily, its new features, and any bugs or issues that have been addressed.
With this in mind, I propose we create and maintain a
CHANGELOG.md
file in the root of our repository. This file should detail the changes for each release in an easy-to-read format, ideally following the conventions outlined in Keep a Changelog.Tasks:
Tasks
Acceptance Criteria:
CHANGELOG.md
file exists in the repository, including all the historical changelog release notes.changelog-update.yml
workflow file to automatically updateCHANGELOG.md
after a new release gets created.