Skip to content

Commit e831166

Browse files
authored
chore: document the criteria for including screenshots (#779)
1 parent c028fb4 commit e831166

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,29 @@ By default, images take up the entire width of the content container. To make th
127127

128128
### Criteria for including a screenshot
129129

130-
See the GitHub's [Creating screenshots](https://docs.github.com/en/contributing/writing-for-github-docs/creating-screenshots) guide.
130+
A screenshot should add something the text cannot. Default to **not** adding one — it should support the text, not repeat it. If the text alone already gets the point across, leave the screenshot out. See GitHub's [Creating screenshots](https://docs.github.com/en/contributing/writing-for-github-docs/creating-screenshots) guide for the general approach.
131+
132+
**Add a screenshot when:**
133+
134+
- The element is hard to find or its location isn't obvious (for example, hidden in a menu or dropdown, or one control among many).
135+
- The interface has competing choices a user could easily get wrong.
136+
- It shows a visual result or layout that's hard to describe in words (a rendered preview, a complex dialog, a chart or diagram).
137+
- It's an orientation checkpoint in a long, multi-step procedure.
138+
139+
**Skip a screenshot when:**
140+
141+
- The text next to it already describes everything it shows.
142+
- It's a standard, self-evident control (a labeled button, a simple form, a plain table) recognizable from its label.
143+
- It's a single icon — reference it inline with the `<Icon>` component instead.
144+
- All its information is already in the text — instead, put the location into the step (for example, "click [icon] next to the [item] and select [option]").
145+
- It shows text, code, or output — use real text instead.
146+
- It contains volatile or demo data (percentages, counts, test names) or personal information.
147+
148+
**Capturing screenshots:**
149+
150+
- Crop to the relevant part of the screen and leave out UI that doesn't help illustrate the point.
151+
- Use realistic content — no lorem ipsum or personal data.
152+
- For a dialog with collapsible sections, capture it in the default (collapsed) state with a bit of realistic data — not everything expanded. It's what users see, and it avoids repeating fields the text already lists.
131153

132154
## File-based/String-based content differentiation
133155

0 commit comments

Comments
 (0)