bevy/.github
MrGVSV c1a2378790 Add "Changelog" and "Migration Guide" to PR template (#4143)
# 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>
2022-03-16 20:48:42 +00:00
..
contributing Added API guidelines to CONTRIBUTING.md (#3646) 2022-01-16 02:40:25 +00:00
example-run CI: use lavapipe instead of swiftshader when running examples (#3358) 2021-12-17 23:58:09 +00:00
ISSUE_TEMPLATE new labels: feature request 2021-07-13 13:29:05 -07:00
linters Ignore reddit when checking markdown links (#3223) 2021-11-29 20:55:12 +00:00
workflows Deploy dev docs - install dependencies (#4222) 2022-03-16 02:08:25 +00:00
bors.toml Re-enable nightly checks and add new dependency duplicate (#3525) 2022-01-02 20:18:53 +00:00
dependabot.yml dependabot: use new C-Dependencies label 2021-07-13 12:51:48 -07:00
FUNDING.yml Create FUNDING.yml 2020-08-18 10:59:30 -07:00
label-config.yml Relicense Bevy under the dual MIT or Apache-2.0 license (#2509) 2021-07-23 21:11:51 +00:00
pull_request_template.md Add "Changelog" and "Migration Guide" to PR template (#4143) 2022-03-16 20:48:42 +00:00