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.

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

Improve PR template to encourage appropriate context in descriptions #4815

Closed
Closed
Changes from 11 commits
Commits
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
26 changes: 10 additions & 16 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,21 @@
# Objective

- Describe the objective or issue this PR addresses.
- If you're fixing a specific issue, say "Fixes #X".
Why are you making these changes?
Link any associated issues with "Fixes #X" so they can be automatically closed.
If this is a particularly complex PR, please add a clear list of the changes made.
alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved

## Solution
Discuss any background information that may be needed for someone unfamiliar with this area of the code to understand the changes you've made.
alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved
This may include related issues, previous discussion, or links to documentation.

- Describe the solution used to achieve the objective above.
## Feedback wanted

alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved
---
> This section is optional. If there are no particularly tricky or controversial changes, you can delete this section.

## 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!
Which parts of this PR were you unsure about? Which parts were particularly tricky?

## 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.
If this PR is a breaking change, describe how a user might need to migrate their code to support these changes
alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved
Adding new functionality or fixing bugs is not a breaking change.