search

MarcSerraPeralta / py-package-template

Template for creating a python package repository
MIT License
0 stars 0 forks source link

Add `CHANGELOG.md` #4

Closed MarcSerraPeralta closed 2 months ago

MarcSerraPeralta commented 2 months ago

Is it necessary? Because GitHub (and other tools) allow to create a CHANGELOG automatically from the commit messages. It is true that maybe they don't look as nice, but with nice commit messages they avoid forgetting about changing the CHANGELOG and let's one use the time in some other thing.

MarcSerraPeralta commented 2 months ago

I believe that the CHANGELOG that is automatically created by GitHub for every release is good enough and that no manual CHANGELOG.md needs to be updated. This avoids possible (manual) mistakes. In the case that the repo was moved to another hosting site (that is not GitHub), I would search for tools that automatically generate the CHANGELOG.md file from the commit messages.