DEV Community

Discussion on: Changelog for developers?

Collapse
 
jamiestevenson profile image
Jamie Stevenson

Some of the examples remind me of guidance for commenting in code i.e. focus more on 'why', less on 'what' or 'how'.

Commit messages should have related/closed issues/bugs, but they could also have the 'why' messages you mention. I am wary of introducing more places to forget to check.

Maybe some sort of markdown in the commit logs to distinguish procedural issue tracking from useful commentary?