pysheds icon indicating copy to clipboard operation
pysheds copied to clipboard
verified publisher icon mdbartos

ENH: Add a CHANGES file

Open remi-braun opened this issue 3 years ago • 3 comments

Hello,

Thanks a lot for your great lib ! 🤩

I would just add a CHANGES (or HISTORY) file in order to help users to follow the versions (with dates)

Best Regards,

Rémi

remi-braun avatar Jan 05 '22 13:01 remi-braun

That's a great idea, thanks for recommending.

For now, the best summary of changes would be PR #162.

mdbartos avatar Jan 05 '22 17:01 mdbartos

Can you post a link to a repo that has an example of a good CHANGE file?

mdbartos avatar Jan 05 '22 18:01 mdbartos

Hello,

There is a lot of lib implementing this and almost one format per lib 😄 I can cite, per exemple:

Other lib prefer to have the changelog that directly in the docs:

Pick the one you prefer, but I think it is really nice to be able to see the evolution of the library in function of versions and time 😉

remi-braun avatar Jan 06 '22 08:01 remi-braun