From 88dddc80903b8f90dad7ecda01f81c6bd1c7fd7c Mon Sep 17 00:00:00 2001 From: Greg Price Date: Wed, 15 Oct 2025 16:47:01 -0700 Subject: [PATCH] docs: Clarify and sharpen request for screenshots vs videos. --- docs/contributing/reviewable-prs.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/contributing/reviewable-prs.md b/docs/contributing/reviewable-prs.md index 7ea15f1fb6..ea0decccb0 100644 --- a/docs/contributing/reviewable-prs.md +++ b/docs/contributing/reviewable-prs.md @@ -172,10 +172,14 @@ review: ``` -- 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.