Create `CHANGELOG.md` - Githubissues

desy-ml / cheetah

Fast and differentiable particle accelerator optics simulation for reinforcement learning and optimisation applications.

https://cheetah-accelerator.readthedocs.io

GNU General Public License v3.0

27 stars 12 forks source link

Create `CHANGELOG.md` #74

Closed jank324 closed 9 months ago

jank324 commented 9 months ago

We should create and maintain a CHANGELOG.md.

I would propose a format similar to the following (mix of Stable-Baselines3 and https://keepachangelog.com/en/1.0.0/).

E.g.

Unreleased

🚀 Features

Better error messages when beam and accelerator devices don't match (see#42) (@maxmustermann)

💥 Breaking

None

🐛 Bug fixes

Fix BPM issue with ParameterBeam (see#42) (@maxmustermann)
Fix wrong screen reading dimensions (see#42) (@maxmustermann)

🐆 Other

Improve docstrings (see#42) (@maxmustermann)
Implement better testing with pytest (see#42) (@maxmustermann)
Setup formatting with black and isort as well as flake8 listing (see#42) (@maxmustermann)
Add type annotations (see#42) (@maxmustermann)
Setup Sphinx documentation on readthedocs (see#42) (@maxmustermann)

v0.3

🚀 Features

Better error messages when beam and accelerator devices don't match (see#42) (@maxmustermann)

💥 Breaking

None

🐛 Bug fixes

Fix BPM issue with ParameterBeam (see#42) (@maxmustermann)
Fix wrong screen reading dimensions (see#42) (@maxmustermann)

🐆 Other

Improve docstrings (see#42) (@maxmustermann)
Implement better testing with pytest (see#42) (@maxmustermann)
Setup formatting with black and isort as well as flake8 listing (see#42) (@maxmustermann)
Add type annotations (see#42) (@maxmustermann)
Setup Sphinx documentation on readthedocs (see#42) (@maxmustermann)