Style Guide

Some tips on the best way to enter new data into this site

General Tips

• When writing out what something does (e.g. a shortcut for copying text, or some code to print out a line of text), write it like you're finishing a sentence starting with "I want to...". E.g. if you'd say "I want to copy some text", then something like "copy text" is what you should call the shortcut.

Tips for Shortcuts

• The keyboard keys in shortcuts should be separated with plus signs.
• When part of a shortcut involves one of a number of keys (e.g. focusing on a tab in Google Chrome requires pressing the command key and then any number from 1 to 9), describe that type of key in brackets. E.g. Google Chrome's shortcut for focusing on a specific tab would be "command+[tab number]"
• Also when part of a shortcut involves one of a number of keys (e.g. focusing on a tab in Google Chrome), provide an example with a specific key (e.g. "command+3") and say what that specific example will do (e.g. "focus on the third tab")

Tips for Code

• If you're writing out code that takes some arguments, name those arguments descriptively (e.g. for the "puts" method in ruby, your entry might read "puts some_text")
• If you're writing out code that takes arguments or deals with variables in any way, format those variables as they would be formatted in the language the code if from (e.g. camelCase for JavaScript variables and snake_case for Ruby variables)