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.

Sign up for GitHub

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

[Merged by Bors] - Add "Changelog" and "Migration Guide" to PR template #4143

Closed
wants to merge 9 commits into from
Closed

[Merged by Bors] - Add "Changelog" and "Migration Guide" to PR template #4143

Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d84ce75
Updated PR template with new sections
MrGVSV Mar 7, 2022
d0d3864
Apply suggestions from code review
MrGVSV Mar 7, 2022
2133d76
Apply suggestions from code review
MrGVSV Mar 7, 2022
2025f9a
Specified optional sub-headings to Changelog
MrGVSV Mar 8, 2022
d839114
Merge branch 'pr-template-improvement' of https://github.com/MrGVSV/b…
MrGVSV Mar 8, 2022
fd16adb
Apply suggestions from code review
MrGVSV Mar 8, 2022
1ebf761
Merge branch 'pr-template-improvement' of https://github.com/MrGVSV/b…
MrGVSV Mar 8, 2022
38b95b4
Small fix
MrGVSV Mar 8, 2022
e8433f7
Apply suggestions from code review
MrGVSV Mar 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,18 @@
## Solution

- Describe the solution used to achieve the objective above.

---

## \[Optional\] Changelog

- What changed as a result of this PR? If this was a trivial fix, or has no externally-visible impact, feel free to skip this section.
MrGVSV marked this conversation as resolved.
Show resolved Hide resolved
- If applicable, organize changes under "Added", "Changed", or "Fixed" sub-headings
- Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section
- If you can't summarize the work, your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge!

## \[Optional\] Migration Guide

MrGVSV marked this conversation as resolved.
Show resolved Hide resolved
- If this PR is a breaking change (relative to the last release of Bevy), describe how a user might need to migrate their code to support these changes
- Simply adding new functionality is not a breaking change.
- Fixing behavior that was definitely a bug, rather than a questionable design choice is not a breaking change.