bevyengine / bevyengine/bevy

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

Open
#9,104 0 comments 0 reactions 0 assignees View on GitHub
A-Meta C-Docs
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

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](https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md).

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.