Skip to content

Commit 4a0e590

Browse files
committed
github: Use zulip/zulip pull request template style.
Hopefully this will help improve the quality of pull requests to this repository.
1 parent eb19b20 commit 4a0e590

File tree

1 file changed

+41
-10
lines changed

1 file changed

+41
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,49 @@
1-
---
1+
<!-- Describe your pull request here.-->
22

3-
<!--
4-
Remove the fields that are not appropriate
5-
Please include:
6-
-->
3+
Fixes: <!-- Issue link, or clear description.-->
74

8-
**What's this PR do?**
5+
<!-- If the PR makes UI changes, always include one or more still screenshots to demonstrate your changes. If it seems helpful, add a screen capture of the new functionality as well.
96
10-
**Any background context you want to provide?**
7+
Tooling tips: https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html
8+
-->
119

12-
**Screenshots?**
10+
**Screenshots and screen captures:**
1311

14-
**You have tested this PR on:**
12+
**Platforms this PR was tested on:**
1513

1614
- [ ] Windows
17-
- [ ] Linux/Ubuntu
1815
- [ ] macOS
16+
- [ ] Linux (specify distro)
17+
18+
<details>
19+
<summary>Self-review checklist</summary>
20+
21+
<!-- Prior to submitting a PR, follow our step-by-step guide to review your own code:
22+
https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#how-to-review-code -->
23+
24+
<!-- Once you create the PR, check off all the steps below that you have completed.
25+
If any of these steps are not relevant or you have not completed, leave them unchecked.-->
26+
27+
- [ ] [Self-reviewed](https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#how-to-review-code) the changes for clarity and maintainability
28+
(variable names, code reuse, readability, etc.).
29+
30+
Communicate decisions, questions, and potential concerns.
31+
32+
- [ ] Explains differences from previous plans (e.g., issue description).
33+
- [ ] Highlights technical choices and bugs encountered.
34+
- [ ] Calls out remaining decisions and concerns.
35+
- [ ] Automated tests verify logic where appropriate.
36+
37+
Individual commits are ready for review (see [commit discipline](https://zulip.readthedocs.io/en/latest/contributing/commit-discipline.html)).
38+
39+
- [ ] Each commit is a coherent idea.
40+
- [ ] Commit message(s) explain reasoning and motivation for changes.
41+
42+
Completed manual review and testing of the following:
43+
44+
- [ ] Visual appearance of the changes.
45+
- [ ] Responsiveness and internationalization.
46+
- [ ] Strings and tooltips.
47+
- [ ] End-to-end functionality of buttons, interactions and flows.
48+
- [ ] Corner cases, error conditions, and easily imagined bugs.
49+
</details>

0 commit comments

Comments
 (0)