Skip to content

Update Pull Request template #59062

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.

Sign up for GitHub

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

Merged
ChristopherBiscardi merged 2 commits into from
Jun 12, 2026
Merged

Update Pull Request template #59062

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f151e0b
update pr template
ChristopherBiscardi Jun 10, 2026
d040589
link to github docs for "Fixes" syntax
ChristopherBiscardi Jun 11, 2026
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
37 changes: 35 additions & 2 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,45 @@
Self-Review Checklist:
# Objective

- Describe the objective or issue this PR addresses.
- If you're fixing a specific issue, say "Fixes #X".
Comment thread
ChristopherBiscardi marked this conversation as resolved.
Outdated

## Solution

- Describe the solution used to achieve the objective above.
Comment thread
ChristopherBiscardi marked this conversation as resolved.

## 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
- [ ] The content adheres to Zed's UI standards ([UX/UI](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) and [icon](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md) guidelines)
- [ ] 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:

@MrSubidubi MrSubidubi Jun 11, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure it's worth a mention here, but I sometimes like having a markdown table with a before/after for visual changes as it's easier to have them side by side to compare frequently


<details>
<summary>Click to view showcase</summary>

My super cool demos here

</details>

---

Release Notes:

Expand Down
Loading