paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify and sharpen request for screenshots vs videos.

Browse Source
This commit is contained in:
Greg Price
2025-10-15 16:47:01 -07:00
committed by Tim Abbott
parent 75c0f0286f
commit 88dddc8090
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing/reviewable-prs.md
View File

@@ -172,10 +172,14 @@ review:
</details>
```
- Screencasts are difficult to review, so use them only when necessary to
demonstrate an interaction. Keep videos as short as possible. If your changes
can be seen on a screenshot, be sure to include screenshots in addition to any
videos.
- Screenshots are much easier to review than screencast videos.
Wherever possible, use still screenshots instead of videos.
Use a video only when necessary to demonstrate an interaction,
and include screenshots too for any aspects of your changes
which can be seen on a still screenshot.
Keep any videos as short as possible, so that the reviewer can
quickly get to the relevant part.
- For before and after images or videos of changes, using GithHub's table
syntax renders them side-by-side for quick and clear comparison.