]> git.openstreetmap.org Git - nominatim.git/blobdiff - CONTRIBUTING.md
Merge pull request #660 from mtmail/new-github-URL
[nominatim.git] / CONTRIBUTING.md
index 04ed748b22da16cd5095fcda7ce77f44adbffed7..276137f6d9c9b0c8ace6ac8832f42460a46b8d6d 100644 (file)
@@ -18,7 +18,7 @@ are in process of consolodating the style. The following rules apply:
  * Python code uses the official Python style
  * indention
    * SQL use 2 spaces
  * Python code uses the official Python style
  * indention
    * SQL use 2 spaces
-   * all other use files TABs
+   * all other file types use 4 spaces
    * [BSD style](https://en.wikipedia.org/wiki/Indent_style#Allman_style) for braces
  * spaces
    * spaces before and after equal signs and operators
    * [BSD style](https://en.wikipedia.org/wiki/Indent_style#Allman_style) for braces
  * spaces
    * spaces before and after equal signs and operators
@@ -27,21 +27,22 @@ are in process of consolodating the style. The following rules apply:
    * leave out space between a function name and bracket
      but add one between control statement(if, while, etc.) and bracket
 
    * leave out space between a function name and bracket
      but add one between control statement(if, while, etc.) and bracket
 
+The coding style is enforced with PHPCS and can be tested with:
 
 
-This coding style must be applied to any new or changed code. You are also
-welcome to fix the coding style of existing code but please submit separate
-PRs for this.
+```
+  phpcs --report-width=120 --colors */**.php
+```
 
 ## Testing
 
 Before submitting a pull request make sure that the following tests pass:
 
 ```
 
 ## Testing
 
 Before submitting a pull request make sure that the following tests pass:
 
 ```
-  cd tests
-  NOMINATIM_DIR=<builddir> lettuce -t -Fail features/db features/osm2pgsql
+  cd test/bdd
+  behave -DBUILDDIR=<builddir> db osm2pgsql
 ```
 
 ```
 ```
 
 ```
-  cd test-php
+  cd test/php
   phpunit ./
 ```
   phpunit ./
 ```