]> git.openstreetmap.org Git - nominatim.git/blobdiff - CONTRIBUTING.md
Revert "increase weight for country tokens"
[nominatim.git] / CONTRIBUTING.md
index a00d0ed354aa68ac5ffe4a00d107253f4c62874d..cd8d1cc1bd7c16d042b356eb385f116d787052fa 100644 (file)
@@ -41,7 +41,7 @@ Please add the following information to your issue:
 
 ## Workflow for Pull Requests
 
 
 ## Workflow for Pull Requests
 
-We love to get pull reuqests from you. We operate the "Fork & Pull" model
+We love to get pull requests from you. We operate the "Fork & Pull" model
 explained at
 
 https://help.github.com/articles/using-pull-requests
 explained at
 
 https://help.github.com/articles/using-pull-requests
@@ -65,7 +65,7 @@ that duplicate work can be avoided.
 ## Coding style
 
 Nominatim historically hasn't followed a particular coding style but we
 ## Coding style
 
 Nominatim historically hasn't followed a particular coding style but we
-are in process of consolodating the style. The following rules apply:
+are in process of consolidating the style. The following rules apply:
 
  * Python code uses the official Python style
  * indention
 
  * Python code uses the official Python style
  * indention
@@ -78,11 +78,13 @@ are in process of consolodating the style. The following rules apply:
    * no spaces after opening and before closing bracket
    * leave out space between a function name and bracket
      but add one between control statement(if, while, etc.) and bracket
    * no spaces after opening and before closing bracket
    * leave out space between a function name and bracket
      but add one between control statement(if, while, etc.) and bracket
+ * for PHP variables use CamelCase with a prefixing letter indicating the type
+   (i - integer, f - float, a - array, s - string, o - object)
 
 The coding style is enforced with PHPCS and can be tested with:
 
 ```
 
 The coding style is enforced with PHPCS and can be tested with:
 
 ```
-  phpcs --report-width=120 --colors */**.php
+  phpcs --report-width=120 --colors .
 ```
 
 ## Testing
 ```
 
 ## Testing