RohanNero / block3d

An open-source authentication toolkit designed to streamline access control within Nextjs dapps.
https://block3d.gitbook.io/block3d
GNU General Public License v3.0
1 stars 0 forks source link

Implement change log to document updates between package versions #9

Open RohanNero opened 1 week ago

RohanNero commented 1 week ago

Overview

We want to document and keep track of changes/upgrades made to the package.

Solution

There are many different solutions to this, we could add a section to our README, a new CHANGELOG.md, or use some existing tooling such as changesets.

I don't really want to increase the package size by adding a new file for this since most people won't care about it anyway.

I think the best approach is to add a CHANGELOG.md or equivalent file to this repo and the documentation but exclude it from the published package. (This repo and the published repo will be slightly more different but they were anyway since the source code is here.)