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 1 commit
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
25 changes: 18 additions & 7 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
# Objective

- Describe the objective or issue this PR addresses.
- If you're fixing a specific issue, say "Fixes #X".
Describe the objective or issue this PR addresses.

## Solution
If you're fixing a specific issue, say "Fixes #X" and the linked issue will automatically be closed when this PR is merged.
alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved
Under each bullet point, describe how this change addressed those objectives if it is not obvious.

- Describe the solution used to achieve the objective above.
**Changes that will affect external library users must update RELEASES.md before they will be merged.**

---
## Context

Discuss any context that may be needed for a user with only passing acquaintance with this library 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 relevant bits of how the library works).
alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved

## 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.

Which parts of this PR were you unsure about? Which parts were particularly tricky?

If you're stuck on part of the changes or want feedback early, open a draft PR and list the items that need to be completed here using a checklist.

## Changelog

Expand All @@ -22,6 +33,6 @@

> 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
- If this PR is a breaking change (relative to the last release of this library), 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.
- Fixing behavior that was definitely a bug, rather than a questionable design choice, is not a breaking change.