Style Guide

Style Guide style guide

• Always place a table of contents at the top of the style guide.

• Each section should start with a second-level header (##).

• Each rule should be a list item * in an un-ordered list.

• Indent code block examples 4 spaces to make them fall inside the list item.

• All code block examples should have code-level comments marking good/bad examples.

• When referencing methods/operators in the rule description, escape like this.

How to use this style guide in pull requests

Hovering over a style guide rule should bring up the icon. Click this icon to set the page url to the section you want to quote.

Copy the url and paste it in a line-level comment on the offending pull request.