zulip 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:
- Start with a
Fixes: #...line linking the issue being addressed. - Explain why the change is needed, not just what changed.
- Describe how you tested the change, using checkbox format for the
test plan (e.g.,
- [x] ./tools/test-backend ...). - Include screenshots for UI changes.
- Link to relevant issues or discussions.
- Call out any open questions, concerns, or decisions you are uncertain about, so they can be resolved during review.
- Include the self-review checklist from
.github/pull_request_template.mdusing 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