Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CHANGELOG.md #74

Closed
jank324 opened this issue Sep 14, 2023 · 0 comments · Fixed by #75
Closed

Create CHANGELOG.md #74

jank324 opened this issue Sep 14, 2023 · 0 comments · Fixed by #75
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jank324
Copy link
Member

jank324 commented Sep 14, 2023

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

🐆 Other

v0.3

🚀 Features

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

💥 Breaking

  • None

🐛 Bug fixes

🐆 Other

@jank324 jank324 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 14, 2023
@cr-xu cr-xu linked a pull request Sep 14, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant