Define a CHANGELOG convention - Githubissues

openzim / overview

:balloon: Start here for current projects, how to get involved, and joining community calls. A resource for new and veteran members of the offline commmunity

2 stars 1 forks source link

Define a CHANGELOG convention #25

Open benoit74 opened 9 months ago

benoit74 commented 9 months ago

In Python bootstrap, we have decided to adopt the Keep a Changelog format for the CHANGELOG.md.

Two open topics:

Do we want to make this an openZIM convention? (in which case we should probably add a wiki section on this)
This format does not clearly define what should be in the changelog: as asked here, should we mention only code changes or also track changes made to the repo (e.g. Github workflows, stale bot configuration, ...)