Adding a CHANGELOG file

scikit-learn-contrib / scikit-matter

A collection of scikit-learn compatible utilities that implement methods born out of the materials science and chemistry communities

https://scikit-matter.readthedocs.io/en/v0.2.0/

BSD 3-Clause "New" or "Revised" License

70 stars 18 forks source link

Adding a CHANGELOG file #198

Closed PicoCentauri closed 10 months ago

PicoCentauri commented 1 year ago

The CHANGELOG is also shown in the documentation as the last entry in the manu. Also, we now have a template for new PRs with a small checklist.

The CHANGELOG is now at version 0.1.5. I also updated the version accordingly.

PR Checklist

[ ] Tests?
[ ] Docs?
[x] CHANGELOG updated?
[ ] Issue raised/referenced?

:books: Documentation preview :books:: https://scikit-matter--198.org.readthedocs.build/en/198/

agoscinski commented 1 year ago

Can we add the changelog with the text up to version 0.1.4 in one commit, and then update the version together with changes in the changelog in another commit? I find it confusing if we mark commit fe58c89 as v0.1.5 commit while the other commit increases the version.

PicoCentauri commented 12 months ago

Yes, good idea. I can change this.

PicoCentauri commented 12 months ago

It is done @agoscinski

agoscinski commented 10 months ago

Can you add to the pyproject.toml the changelog?

[project.urls]
homepage = "https://example.com"
documentation = "https://readthedocs.org"
repository = "https://github.com"
changelog = "https://github.com/me/spam/blob/master/CHANGELOG.md"

Source https://peps.python.org/pep-0621/