Skip to content

Commit 2968d41

Browse files
authored
meta: Add Showcase section to PR template (#11750)
# Objective Oftentimes I find myself reading through a PR and not quite understanding what's going on. Even if it's super detailed, it can sometimes be difficult to imagine what the end result of the PR might look like. For example, #10756 clearly communicates its goals and contains a descriptive Changelog. However, I was still a bit lost as to what a user might see from the change until I saw the dedicated example in the diff. ## Solution At the risk of giving contributors more work, I think a dedicated `Showcase` section could be really nice. Along with providing reviewers stumbling on the PR with a "tangible summary" of the change, it should also help out when working on the release post. Sometimes someone other than the PR's author has to write up a blog section on the PR. This can be somewhat daunting to people wanting to contribute in that effort as they have to rely on the Migration Guide giving a decent example (assuming it's a breaking change), piecing together the other sections into a sensible example themselves, or manually reading through the diff. Theoretically, this new `Showcase` section would be more of an encouragement than a strict requirement. And it's probably only going to be useful where there is something to showcase (e.g. visual changes, API changes, new features, etc.). ### Bikeshedding - **Naming.** I also considered `Demo` and `Example`, but there may be others we prefer. I chose `Showcase` to communicate the feeling of fun and appreciation for the work contributors put in. - **Position.** I placed the section right above the `Changelog` section since I felt it made sense to move from the details in `Solution` to a brief example in `Showcase` to a tl;dr of the changes in `Changelog` - **Phrasing.** We can also bikeshed the bullet points and phrasing of each as well.
1 parent b30b0a7 commit 2968d41

File tree

2 files changed

+25
-7
lines changed

2 files changed

+25
-7
lines changed

.github/linters/.markdown-lint.yml

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
{
2-
"MD013": false
2+
"MD013": false,
3+
"no-inline-html": {
4+
"allowed_elements": [
5+
"details",
6+
"summary"
7+
]
8+
}
39
}

.github/pull_request_template.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,26 @@
1616

1717
---
1818

19-
## Changelog
19+
## Showcase
2020

21-
> This section is optional. If this was a trivial fix, or has no externally-visible impact, you can delete this section.
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.
2222
23-
- What changed as a result of this PR?
24-
- If applicable, organize changes under "Added", "Changed", or "Fixed" sub-headings
25-
- Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section
26-
- 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!
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>
2739

2840
## Migration Guide
2941

0 commit comments

Comments
 (0)