Spaces around assignments - addressed #1

Author: tsafin

README.md

@@ -1,23 +1,24 @@
 # cos-guidelines
-There is mandatory and recommended parts. _Recommended part to being formed at the moment_
+This is the first approximation of COS guidelines we use for github.com/intersystems-ru projects. There are mandatory and recommended parts.
 
-But here is general advice: use common sense and try to *be consistent* wherever you write code. 
+We do not plan to be too much restrictive, but rather flexible enough to allow many reasonable styles. 
+Here is the general advice: use common sense and try to *be consistent* wherever you write code. 
 If there is some style already established in the class or utility being modified then we recommend
 to continue use that same style, than introducing yet another one, which may be more recommended 
-but will produce inconsistent results.
+but which will be introducing some unnecessary inconsistency.
 
 ## Mandatory part
 
 * Only "modern" syntax permitted, dotted syntax is not generally allowed (with few exceptions)
-* No short name for statements keywords allowed - use fully expanded keyword names. This same rule applie to builtin function names - they should be fully pronounced.
+* No short name for statements keywords or built-in functions allowed - use fully expanded names.
 
 ## Recommended part
-* We recommend to use fully expanded keyword in lower case or capitalized. Whatever you'll select should be consistent across class or utility, i.e.
+* We recommend to use fully expanded keyword or function name in lower case or capitalized. Whatever you'll select should be consistent across class or utility, i.e.
 ```
 If (expression) {
   Do ##class(Sample).%New(initexpresion)
   For i=1:1:10 {
-    Write something, $Zversion, !
+    Write something, $ZVersion, !
   }
 }
 ```
@@ -31,16 +32,23 @@ If (expression) {
    }
  }
 ```
-* Use the reasonable name convention which is consistent across hierarchy. We recommend to use CamelCase for classes, methods and properties (e.g. `Sample.Person`, `OpenFile`, `LastIndex`, etc.), but smallCamelCase for local variables (e.g. `startDate`, `endDate`), but please be consistent and use local schea if it's different thancurrent recommendation.
-* For better readablity please insert spaces after comma in argument list, i.e.
-```
-  Write 1, 2, 3
-  Do ..Method(Arg1, Arg2, Arg3)
-```
+* Use the reasonable name convention consistently across whole hierarchy. We recommend to use CamelCase for classes, methods and properties (e.g. `Sample.Person`, `OpenFile`, `LastIndex`, etc.), but smallCamelCase for local variables (e.g. `startDate`, `endDate`), but please be consistent and use local schema if it's different than current recommendation.
 * We recommend to use `#dim` statement for declaration of local variables types, e.g.
 ```
   #dim array as %ArrayOfDataTypes = ##class(%ArrayOfDataTypes).%New()
   do array.SetAt(id, "id")
   #dim status As %Status = $$$OK
 ```
  This will help editor to provide better auto-complete, and eventually will be used by static checker for type informantion extraction.
+* For better readablity please insert spaces after comma in argument list, i.e.
+```
+  Write 1, 2, 3
+  Do ..Method(Arg1, Arg2, Arg3)
+```
+* For better readability please insert spaces around assignment. You may align several neighbour assignments according to your tastes, i.e.
+```
+  #dim index As %Integer = 0
+  #dim countOfItems As %Integer = ..Count()
+  set j  = k + 1
+  set iN = jN \ l
+```