Documentation contribution checklist

This page is a summary of the guidelines to follow when contributing to the documentation. Before you press that Create pull request button on GitHub, read over this list to double check if you missed anything.

You don't need to read all the guidelines here in order to start contributing. If you do miss something, it will be pointed out during review. However, following the guidelines you are aware of as best you can will help speed up the review process.

Writing style

7 rules for clear English

• Use the active voice.

• Use precise action verbs.

• Avoid verbs that end in -ing.

• Remove unnecessary adverbs and adjectives.

• Ban these 8 words: obvious, simple, basic, easy, actual, just, clear, and however.

• Use explicit references.

• Use 's to show possession.

• Use the Oxford comma.

Code examples

• Use dynamic typing. Dynamic vs static typing

• Use real, practical examples. Avoid foo / bar examples. Use real-world code examples where appropriate

Manual style and formatting

• Use common vocabulary for the editor interface. Common vocabulary to use in Godot's documentation

• Use :kbd: for keyboard shortcuts. Keyboard shortcut guidelines

• Literals use code style. Literals

• Classes link to the class reference once, then use ClassName for the rest of the page. Methods and properties link to the class ref once, then use PropertyName for the rest of the page. Classes, properties, and methods

• Editor UI, like menus, windows, and editor navigation paths, use Bold Style. Editor UI

• Link to project settings when referencing them. Project settings

• Text is manually wrapped to 80-100 characters. Manually wrapping lines

• No trailing whitespace at the end of lines.

• Most of the time, avoid mentioning a specific Godot version. When to refer to a specific Godot version

Images and videos

• New (and updated) images are in WebP format. Format conversion

• Editor screenshots are cropped. Cropping

• Images larger than 1080p or 300kb are scaled down. Scaling down an image

• Outlines in images use fffb44 yellow. Outlines, arrows and text

• Videos use the :autoplay:, :loop:, and :muted: tags. Videos

GitHub

• The PR title starts with a word like Fix, Add, Update, Clarify, or Improve.

• If the PR closes an issue, link to the issue with one of GitHub's keywords: closes, fixes, or resolves, in the text of the PR.

• Ideally, PR contains a single commit. However, multiple commits can be The interactive rebase later.