Skip to content

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

Manual style and formatting

Images and 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.