Github user benkeen commented on a diff in the pull request:
https://github.com/apache/couchdb-fauxton/pull/91#discussion_r18743854
--- Diff: styleguide.md ---
@@ -0,0 +1,192 @@
+# JavaScript Style Guide
+
+This document attempts to codify the JavaScript code style rules for
Fauxton. This has been patched together from
+a few sources, including [Pootle's style
guide](http://pootle.readthedocs.org/en/latest/developers/styleguide.html#javascript),
+[Google JS style
guide](https://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml),
and from
+reverse-engineering our own codebase.
+
+This is intended to be a living document: any disagreements about style
should be brought to the community via IRC,
+discussed, agreed upon and documented here.
+
+Note: We have JSHint running as a grunt task which will catch the more
egregious errors (missing `vars`, missing
+semicolons etc). See the `Gruntfile.js` for the settings being used.
+
+
+## Programming Style
+
+#### Strings
+Use `'` single quote character for strings, because HTML markup uses `"`.
Eg. `var greeting = 'Hello World!'`;
+
+#### Numbers
+When using `parseInt` always explicitly include the second radix argument
(usually 10).
+
+#### Indentation
+- 2-space indentation. Don't use tabs. JSHint will whine if you have mixed
tabs and spaces.
--- End diff --
Yeah all our JS is 2-space (I actually find that a little too short myself,
but I wasn't going to fight a war over it). Our HTML templates are mostly
2-spaces too I think. Depending on how this PR goes, I was thinking of doing a
separate HTML style guide.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
