search

pyMBE-dev / pyMBE

pyMBE provides tools to facilitate building up molecules with complex architectures in the Molecular Dynamics software ESPResSo. For an up-to-date API documention please check our website:
https://pymbe-dev.github.io/pyMBE/pyMBE.html
GNU General Public License v3.0
5 stars 7 forks source link

Introduce a Changelog #66

Closed pm-blanco closed 4 weeks ago

pm-blanco commented 1 month ago

In other to help admins and users of library, we should start maintaining a changelog starting with the upcoming first stable version of pyMBE. The suggested format is to use Keep A Changelog 1.1.0.

jngrad commented 1 month ago

Do we still have deprecated or unused functions lying around? Once we have a changelog in place, every time we remove a deprecated function, we must add an extra line in the changelog to document it as an API change.

pm-blanco commented 1 month ago

@jngrad I believe that I managed to remove all of them from pymbe.py but I still need to do a proper clean-up of the library modules. I will do it before the release of 0.8 to try to minimize the number of API changes as much as possible

jngrad commented 1 month ago

For completeness, Common Changelog is quite similar and better documented, but isn't widely adopted yet.