Skip to content

Conversation

ThomSerg
Copy link
Collaborator

@ThomSerg ThomSerg commented May 5, 2025

As mentioned in #666, now that we'll again be using the changelog.md file for documenting the changes included in each release, it would be nice if we decided on a consistent template.

We've used many names for the same subsections before:

  • What's Changed
  • What's New
  • What's new?
  • New:
  • ...

Either we create our own template, use the one from keepachangelog or make some hybrid. But as seen in release 0.9.24, sometimes we might want to break out of a strict template as to for example better highlight our efforts on performance improvements. The format included in this pull request is in the "keepachangelog" format.

Any thoughts / opinions?

@ThomSerg
Copy link
Collaborator Author

ThomSerg commented May 5, 2025

Maybe the dropping of Python version 3.7 should be under the label Deprecated / Removed (if following the "keepachangelog" convention)

@IgnaceBleukx
Copy link
Collaborator

Regarding the classes we want in the changelog, I think it makes sense to mimic the labels we have on our PRs?
I.e., "Documentation", "Bug", "Enhancement"(can be user experience or performance) or "New solver"

@hbierlee
Copy link
Contributor

hbierlee commented May 6, 2025

I like the keepachangelog format and to be consistent. I think even for performance improvements, it's ok to just add them under Changes if I squint at what they mean with each category:

Types of changes

Added: for new features.
Changed: for changes in existing functionality.
Deprecated: for soon-to-be removed features.
Removed: for now removed features.
Fixed: for any bug fixes.
Security: in case of vulnerabilities.

@ThomSerg ThomSerg mentioned this pull request May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants