diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index 3d9dcfe..a6ab282 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -54,6 +54,10 @@ your point, not as complete running programs. If a complete running program is necessary, include it as an asset in `assets/code-examples` and link to it. +* When using underscores, asterisks and backticks please use proper escaping (**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**) +* References to constructor functions should start with upper-case letters +* References to constructor instances should be camel-case +* References to methods should be used with parenthesis: `socket.end()` instead of `socket.end` [plugin]: http://editorconfig.org/#download [Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma