Skip to content

Commit 9cc59cb

Browse files
committed
Add pull_request_template - copied directly from bevy
1 parent f418479 commit 9cc59cb

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Objective
2+
3+
- Describe the objective or issue this PR addresses.
4+
- If you're fixing a specific issue, say "Fixes #X".
5+
6+
## Solution
7+
8+
- Describe the solution used to achieve the objective above.
9+
10+
## Testing
11+
12+
- Did you test these changes? If so, how?
13+
- Are there any parts that need more testing?
14+
- How can other people (reviewers) test your changes? Is there anything specific they need to know?
15+
- If relevant, what platforms did you test these changes on, and are there any important ones you can't test?
16+
17+
---
18+
19+
## Showcase
20+
21+
> This section is optional. If this PR does not include a visual change or does not add a new feature, you can delete this section.
22+
23+
- Help others understand the result of this PR by showcasing your awesome work!
24+
- If this PR adds a new feature or public API, consider adding a brief pseudo-code snippet of it in action
25+
- If this PR includes a visual change, consider adding a screenshot, GIF, or video
26+
- If you want, you could even include a before/after comparison!
27+
- If the Migration Guide adequately covers the changes, you can delete this section
28+
29+
While a showcase should aim to be brief and digestible, you can use a toggleable section to save space on longer showcases:
30+
31+
<details>
32+
<summary>Click to view showcase</summary>
33+
34+
```rust
35+
println!("My super cool code.");
36+
```
37+
38+
</details>

0 commit comments

Comments
 (0)