lifeomic / app-tools

Common utilities for PHC app development
MIT License
0 stars 0 forks source link

Add CHANGELOG.md #18

Closed Druotic closed 4 years ago

Druotic commented 4 years ago

Originally I set up husky + auto-changelog to auto generate a changelog just before each push (and detect if a change occurred). However https://keepachangelog.com/en/1.0.0/ explicitly discourages 'dumping git logs'. I think it could work if commits were curated or added a pattern for consistent docs. For now, keeping it simple/manual as an improvement to no changelog.

E.g. to see what that'd look like, there's a start here: https://github.com/lifeomic/app-tools/pull/17 (I have a couple of more recent changes local I didn't push, but I could revive it if people think automated is better than the possibility of people forgetting to manually update)