X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/34f8e6ddf76f511fe2a58a8e09a27b88e9f68dd1..bc94318d8349404f7112a6214c782cfc1c290a64:/CONTRIBUTING.md?ds=sidebyside diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d2877bf..e031cd91 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ Nominatim historically hasn't followed a particular coding style but we are in process of consolidating the style. The following rules apply: * Python code uses the official Python style - * indention + * indentation * SQL use 2 spaces * all other file types use 4 spaces * [BSD style](https://en.wikipedia.org/wiki/Indent_style#Allman_style) for braces @@ -49,22 +49,18 @@ are in process of consolidating the style. The following rules apply: * 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 pylint. It can be tested with: ``` - phpcs --report-width=120 --colors . +phpcs --report-width=120 --colors . +pylint3 --extension-pkg-whitelist=osmium nominatim ``` ## Testing -Before submitting a pull request make sure that the following tests pass: +Before submitting a pull request make sure that the tests pass: ``` - cd test/bdd - behave -DBUILDDIR= db osm2pgsql -``` - -``` - cd test/php - phpunit ./ + cd build + make test ```