64898b2c79
Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
30 lines
1.2 KiB
Markdown
30 lines
1.2 KiB
Markdown
---
|
|
name: pr-description
|
|
description: "Write a pull request description following Zulip's guidelines. Use when opening a pull request or drafting/revising its title or description."
|
|
---
|
|
|
|
# PR Descriptions
|
|
|
|
Output the PR description in a markdown code block so that formatting
|
|
(bold, headers, checkboxes, etc.) copy-pastes correctly into GitHub.
|
|
|
|
## A PR description should:
|
|
|
|
1. Start with a `Fixes: #...` line linking the issue being addressed.
|
|
2. Explain **why** the change is needed, not just what changed.
|
|
3. Describe how you tested the change, using checkbox format for the
|
|
test plan (e.g., `- [x] ./tools/test-backend ...`).
|
|
4. Include screenshots for UI changes.
|
|
5. Link to relevant issues or discussions.
|
|
6. Call out any open questions, concerns, or decisions you are uncertain
|
|
about, so they can be resolved during review.
|
|
7. Include the self-review checklist from
|
|
`.github/pull_request_template.md` using checkbox format (`- [x]` /
|
|
`- [ ]`), checking off all applicable items.
|
|
|
|
## A PR description should not:
|
|
|
|
- Regurgitate information visible from the diff
|
|
- Make claims you haven't double-checked
|
|
- Express more certainty than is justified given the evidence
|