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

Clearly document possibly breaking changes #4306

Closed
dreusel opened this issue Dec 27, 2024 · 1 comment
Closed

Clearly document possibly breaking changes #4306

dreusel opened this issue Dec 27, 2024 · 1 comment

Comments

@dreusel
Copy link

dreusel commented Dec 27, 2024

Feature request

My request is that any updates that can reasonably be expected to break some use-cases (such are removal of some (previously deprecated or not) functions or properties) are marked in a consistent way so that they can easily be checked for by projects utilizing the library. Instead of having to consider every line in the changelog which is time-consuming and error-prone.
For example by adopting a policy to include something like "break:" or "(breaking)" in the description line. And possibly also repeating these changes in the 'minor' section of the changelog file.

This could also be a very helpful step in at some future point bumping to 1.0.0

What are you trying to achieve?

To easily know weather or not some version bump includes breaking changes for my use-cases

When you searched for similar feature requests, what did you find that might be related?

Someone sugested to bump to 1.0.0

@lovell
Copy link
Owner

lovell commented Jan 6, 2025

Thank you for the suggestion, this is a sensible idea. The changelog for the next release has been updated via commit b7ff264 to list breaking changes first. We can continue to use this pattern in the future.

@lovell lovell closed this as completed Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants