Skip to content

Latest commit

 

History

History
40 lines (22 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

40 lines (22 loc) · 1.21 KB
Raw

Contributing

Overview

Contributing is easy:

  1. Fork the repository.
  2. Add pages, improve existing pages, fix typos - whatever.
  3. Push the changes to the forked repository.
  4. Send us a pull request.

Style Guide

Basics

Use the standard Markdown syntax. Only use HTML if there's no Markdown equivalent (e.g. tables).

Use proper English grammar.

Do not create a Contents section. TOCs are dynamically generated with JavaScript.

Do not use quotation marks to emphasize words. Instead use single asterisks (e.g. *foo*) or double asterisks to denote important words (e.g. **bar**).

Code Blocks

Only use inline code and code blocks to markup actual code, file contents or file names.

YAML Front Matter

Indent the values of the YAML Front Matter so that they align with each other.

Headings

Capitalize the words in heading titles according to the MLA format, e.g. Uploading the Language Files.

Add a newline after the heading.

Links

When linking to internal pages use relative links, e.g. [Using FTP](https://docs.mybb.com/install/ftp) should be [Using FTP](install/ftp).