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

Add Breaking Change / Changelog / Migration Guide explanation in the Contributor's Guide #9104

Open
Selene-Amanita opened this issue Jul 10, 2023 · 0 comments
Labels
A-Meta About the project itself C-Docs An addition or correction to our documentation

Comments

@Selene-Amanita
Copy link
Member

Selene-Amanita commented Jul 10, 2023

The Changelog/Migration Guide sections are pre-filled in the placeholder when creating a PR, but they're not mentioned anywhere in the Contributor's Guide.

They should be mentioned as they are used by scripts in the release process, more and more without a human review since the number of PRs per version is growing.

Guidelines about how to write a Migration Guide and/or changelogs would help normalize them and allow us to rely more on scripts too.

@Selene-Amanita Selene-Amanita added C-Docs An addition or correction to our documentation A-Meta About the project itself labels Jul 10, 2023
@Selene-Amanita Selene-Amanita changed the title Add Breaking Change / Changelog / Migration Guide explaination in the Contributor's Guide Add Breaking Change / Changelog / Migration Guide explanation in the Contributor's Guide Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Meta About the project itself C-Docs An addition or correction to our documentation
Projects
None yet
Development

No branches or pull requests

1 participant