CHANGELOG page
ma7dev opened this issue · 0 comments
ma7dev commented
Problem
The user can't know the type of changes that happened in the project without digging through PRs and commits. It would be useful to have a CHANGELOG page where we list changes on the website.
Solution
To log changes, include a CHANGELOG.txt
file where it contains the following information:
AUTHOR,YYYY-MM-DD
CHANGE_1
---
AUTHOR,YYYY-MM-DD
CHANGE_2
---
...
Here are some example values:
YYYY-MM-DD
: 2022-07-09CHANGE_1
: Included changelog pagehttps://arbml.github.io/masader/changelog
AUTHOR
: GITHUB_USERNAME
Update web service to read the changelog.txt
file and do pre-processing to turn it to a json format for ease of reading and processing from the front-end side.
Update front-end codebase to fetch from the web service and display the information correctly.