Style Guide

This is the style guide that contributors will use to add content to the project.

Before You Contribute

This project uses the GFM for its content formatting. Not familiar with it? Visit http://daringfireball.net/projects/markdown/syntax.

Format

Overall

1. Any place where commands or code is noted, the contributor will use the code format.

Tables

For some information, a table is the preferred format. This is best when you have one-liners or short entries that require no extra sample content. In these cases, a simple table can be used to format the data. The table should have at least 2 columns: Command and Description and may have more if desired/warranted. An example of the Markup formatted table is below.

| Command | Description | OS |
| ------- | ----------- | -- |
| `ls` | Lists the files in the current directory. | *nix |

Detailed Entries

Content

Overall

1. Make the entries as descriptive as possible. Remember that a wide audience of people will be reading this content. We are writing so that the novice can understand and the expert find value quickly.
2. Reread your content before submitting a pull request. Ensure that there are no spelling errors and the formatting is correct.
3. Provide URLs or links to other authoritative sites that the reader can visit for more information. We say authoritative so that we use links to quality, sites like Microsoft's Technet for Windows commands instead of "My friend Joe's blog". Try to go to the source when possible.

Code Format