]> source.dussan.org Git - svg.js.git/commitdiff
Updated README
authorwout <wout@impinc.co.uk>
Tue, 29 Jul 2014 13:42:32 +0000 (15:42 +0200)
committerwout <wout@impinc.co.uk>
Tue, 29 Jul 2014 13:42:32 +0000 (15:42 +0200)
README.md

index 2799b34526219c27ac6a3682ec557425d5480e81..dac5255f626e3da72d8836e36c1277638b605011 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -3501,7 +3501,7 @@ Here are a few nice plugins that are available for SVG.js:
 
 
 ## Contributing
-We love contributions. Yes indeed, I used the word LOVE! But please make sure you follow the same coding style. Here are some guidelines.
+We love contributions. Yes indeed, we used the word LOVE! But please make sure you follow the same coding style. Here are some guidelines.
 
 ### Indentation
 We do it with __two spaces__. Make sure you don't start using tabs because then things get messy.
@@ -3531,6 +3531,29 @@ for (var i = 0; i < 5; i++) {
 };
 ```
 
+### Minimize variable declarations
+All local variables should be declared at the beginning of a function or method unless there is ony one variable to declare. Although it is not required to assign them at the same moment. When if statements are involved, requiring some variables only to be present in the statement, the necessary variables should be declared right after the if statement.
+
+__Good__:
+```javascript
+function reading_board() {
+  var aap, noot, mies
+
+  aap  = 1
+  noot = 2
+  mies = aap + noot
+}
+```
+
+__Bad__:
+```javascript
+function reading_board() {
+  var aap  = 1
+  var noot = 2
+  var mies = aap + noot
+}
+```
+
 ### Let your code breathe people!
 Don't try to be a code compressor yourself, they do way a better job anyway. Give your code some spaces and newlines.