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

Update README with info about changelog and BC breaks #190

Open
ghost opened this issue Jun 22, 2024 · 1 comment
Open

Update README with info about changelog and BC breaks #190

ghost opened this issue Jun 22, 2024 · 1 comment

Comments

@ghost
Copy link

ghost commented Jun 22, 2024

HI. This repository does not contan neither CHANGELOG.md nor UPGRADE.md file. I understand that you use GItHub releases as changelog. However I would add a note about that in README.md.

Moreover, many would appreciate explicit information how BC breaks are denoted. This package still hasn't the first major release so every next 0.x release should be considered unstable. However the release notes do not contain any BC BREAK prefix/section and I'm confused whether it's because there haven't been any yet or you just don't add this prefix because every 0.x release should be treated as unstable.

Proposal:
The changelog is maintained with GitHub releases page https://github.com/thephpleague/oauth2-server-bundle/releases.
Backward compatibility breaks are prefixed with [BC BREAK].

@chalasr
Copy link
Member

chalasr commented Aug 26, 2024

Agreed. PR Welcome in that direction

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant