ENH: Add a CHANGES file

mdbartos / pysheds

:earth_americas: Simple and fast watershed delineation in python.

GNU General Public License v3.0

708 stars 191 forks source link

Open remi-braun opened 2 years ago

remi-braun commented 2 years ago

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

mdbartos commented 2 years ago

That's a great idea, thanks for recommending.

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

mdbartos commented 2 years ago

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

remi-braun commented 2 years ago

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 😉