Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

Update Pull Request template (#59062)

Chris Biscardic32c037c6b2b
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index c9ada8f20f2..a948bb5acad 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,4 +1,20 @@
-Self-Review Checklist:
+# Objective
+
+- Describe the objective or issue this PR addresses.
+- If you're fixing a specific issue, use "Fixes #X" for each issue as [described in the GitHub docs](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
+
+## 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?
+
+## Self-Review Checklist:
- [ ] I've reviewed my own diff for quality, security, and reliability
- [ ] Unsafe blocks (if any) have justifying comments
@@ -6,7 +22,24 @@ Self-Review Checklist:
- [ ] Tests cover the new/changed behavior
- [ ] Performance impact has been considered and is acceptable
-Closes #ISSUE
+## Showcase
+
+> This section is optional. If this PR does not include a visual change or does not add a new user-facing feature, you can delete this section.
+
+- Help others understand the result of this PR by showcasing your awesome work!
+- If this PR includes a visual change, consider adding a screenshot, GIF, or video
+ - A before/after comparison is very useful for changes to existing features!
+
+While a showcase should aim to be brief and digestible, you can use a toggleable section to save space on longer showcases:
+
+<details>
+ <summary>Click to view showcase</summary>
+
+My super cool demos here
+
+</details>
+
+---
Release Notes: