mirror of
https://github.com/bevyengine/bevy
synced 2024-11-22 20:53:53 +00:00
c1a2378790
# Objective Context: [Discord Discussion](https://discord.com/channels/691052431525675048/745355529777315850/950532143325519902) Improve the PR template by adding "Changelog" and "Migration Guide" sections. These sections should hopefully help speed up the review/merge process, as well as help make release notes and migration guides. ## Solution Added the "Changelog" section template which suggests listing out the changes of the PR. This also acts as a sort of tl;dr for reviewers (especially for larger PRs). Added the "Migration Guide" section template which suggests describing how a user might need to migrate their codebase to account for the changes by the PR. This also helps authors/contributors keep the end-user in mind when adding or changing the API. Both sections are optional— an author does not _need_ to fill these out. Hopefully they will, though, as it provides a handful of really great benefits. Co-authored-by: MrGVSV <49806985+MrGVSV@users.noreply.github.com> |
||
---|---|---|
.. | ||
contributing | ||
example-run | ||
ISSUE_TEMPLATE | ||
linters | ||
workflows | ||
bors.toml | ||
dependabot.yml | ||
FUNDING.yml | ||
label-config.yml | ||
pull_request_template.md |