docs: add changelog for project history and versioning #17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Congratulations on submitting your first Pull Request! 🎉
We appreciate your contribution. Feel free to join the conversation in our
Community and say hello!
BekahHW
requested changes
Oct 19, 2025
Contributor
BekahHW
left a comment
BekahHW
left a comment
There was a problem hiding this comment.
Hey @abduelmorsi this is a great start. I think we should include the information How to maintain this Changelog at the top of the doc, but commented out so it can inform contributors, but it isn't distracting users.
BekahHW
reviewed
Oct 21, 2025
Comment on lines
32
to
51
| ## [Unreleased] | ||
|
|
||
| ### Added | ||
| - _Nothing yet_ | ||
|
|
||
| ### Changed | ||
| - _Nothing yet_ | ||
|
|
||
| ### Deprecated | ||
| - _Nothing yet_ | ||
|
|
||
| ### Removed | ||
| - _Nothing yet_ | ||
|
|
||
| ### Fixed | ||
| - _Nothing yet_ | ||
|
|
||
| ### Security | ||
| - _Nothing yet_ | ||
|
|
Contributor
There was a problem hiding this comment.
I don't know we want this visible either. What do you think about moving it to the commented out point?
Contributor
Author
There was a problem hiding this comment.
Yeah I believe it should be intented for maintaners as well, I'll work on it
BekahHW
approved these changes
Oct 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Title
docs: add changelog and link from README
Resolves #6
Description
CHANGELOG.mdbased on Keep a Changelog, seeded with the 1.0.0 release notes and future maintenance guidanceREADME.mdso contributors can easily find release historyRelated Issues
Screenshots / Examples
Testing