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

Reconsider how breaking changes are documented #1758

Open
ptodev opened this issue Sep 25, 2024 · 0 comments
Open

Reconsider how breaking changes are documented #1758

ptodev opened this issue Sep 25, 2024 · 0 comments

Comments

@ptodev
Copy link
Contributor

ptodev commented Sep 25, 2024

We currently document breaking changes in both the changelog and in the Release notes doc. Unfortunately, sometimes we forget to update the "Release notes" doc.

Should we add a CI check to make sure that any PR which adds a "breaking change" to the changelog also edits the "Release notes"? Or should we reconsider the need for a Release notes doc, and potentially remove it?

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