mirror of
https://github.com/bevyengine/bevy
synced 2024-11-14 00:47:32 +00:00
abddbf2d95
# Objective - Reviews could go smoother if reviewers know how a PR was tested, how they can test it, and if it needs more testing. ## Solution - Add a testing section
34 lines
1.5 KiB
Markdown
34 lines
1.5 KiB
Markdown
# Objective
|
|
|
|
- Describe the objective or issue this PR addresses.
|
|
- If you're fixing a specific issue, say "Fixes #X".
|
|
|
|
## Solution
|
|
|
|
- Describe the solution used to achieve the objective above.
|
|
|
|
## Testing
|
|
|
|
- Did you test these changes? If so, how?
|
|
- Are there any parts that need more testing?
|
|
- How can other people (reviewers) test your changes? Is there anything specific they need to know?
|
|
- If relevant, what platforms did you test these changes on, and are there any important ones you can't test?
|
|
|
|
---
|
|
|
|
## Changelog
|
|
|
|
> This section is optional. If this was a trivial fix, or has no externally-visible impact, you can delete this section.
|
|
|
|
- What changed as a result of this PR?
|
|
- 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!
|
|
|
|
## Migration Guide
|
|
|
|
> This section is optional. If there are no breaking changes, you can delete this section.
|
|
|
|
- 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.
|