Skip to content

Commit 58ab332

Browse files
authored
chore: formalize video inclusion advice
1 parent 1d6ddb5 commit 58ab332

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,15 @@ To maintain consistency and readability across the documentation, please adhere
9292
7. **Links and references**: When referencing external sources or linking to other pages, use descriptive anchor text and provide full URLs.
9393

9494
8. **Images**: Include images if necessary to illustrate concepts, ensure the images are clear and relevant to the content, and store them in the repository rather than external CDNs (i.e. imgur).
95+
- Including a video is also possible; however, it should be short and adequately compressed. If the video does not need interaction, e.g. pausing, using an animated image (GIF, WebP, ...) is preferred, as it grabs attention better (auto-play) and can be further optimized by the build tooling.
9596

96-
9. **Format code**: After you've made changes, don't forget to run the formatting script with `pnpm run format`.
97+
10. **Format code**: After you've made changes, don't forget to run the formatting script with `pnpm run format`.
9798

98-
10. **Keep it concise**: Write clear and concise sentences. Avoid unnecessary jargon and explanations.
99+
11. **Keep it concise**: Write clear and concise sentences. Avoid unnecessary jargon and explanations.
99100

100-
11. **Be inclusive**: Be mindful of all readers and contributors. Use language that is inclusive and welcoming to everyone.
101+
12. **Be inclusive**: Be mindful of all readers and contributors. Use language that is inclusive and welcoming to everyone.
101102

102-
12. **Capitalize Vanilla**: When referring to the base game, use "Vanilla" with a capital "V".
103+
13. **Capitalize Vanilla**: When referring to the base game, use "Vanilla" with a capital "V".
103104

104105
## Version tags
105106

0 commit comments

Comments
 (0)