add postcodes for most of the remaining countries

[nominatim.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a00d0ed354aa68ac5ffe4a00d107253f4c62874d..6798c39dc1fcde20525204cd2af4abbc2e392e2a 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -7,41 +7,9 @@ Please always open a separate issue for each problem. In particular, do
 not add your bugs to closed issues. They may looks similar to you but
 often are completely different from the maintainer's point of view.
 
-### When Reporting Bad Search Results...
-
-Please make sure to add the following information:
-
- * the URL of the query that produces the bad result
- * the result you are getting
- * the expected result, preferably a link to the OSM object you want to find,
-   otherwise an address that is as precise as possible
- 
- To get the link to the OSM object, you can try the following:
- 
- * go to https://openstreetmap.org
- * zoom to the area of the map where you expect the result and
-   zoom in as much as possible
- * click on the question mark on the right side of the map,
-   then with the queston cursor on the map where your object is located
- * find the object of interest in the list that appears on the left side
- * click on the object and report the URL back that the browser shows
-
-### When Reporting Problems with your Installation...
-
-Please add the following information to your issue:
-
- * hardware configuration: RAM size, CPUs, kind and size of disks
- * Operating system (also mention if you are running on a cloud service)
- * Postgres and Postgis version
- * list of settings you changed in your Postgres configuration
- * Nominatim version (release version or,
-   if you run from the git repo, the output of `git rev-parse HEAD`)
- * (if applicable) exact command line of the command that was causing the issue
-
-
 ## 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
@@ -65,7 +33,7 @@ that duplicate work can be avoided.
 ## 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
@@ -78,23 +46,21 @@ 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
+ * 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 */**.php
+phpcs --report-width=120 --colors .
+pylint3 --extension-pkg-whitelist=osmium nominatim
 ```
 
 ## Testing
 
-Before submitting a pull request make sure that the following tests pass:
-
-```
-  cd test/bdd
-  behave -DBUILDDIR=<builddir> db osm2pgsql
-```
+Before submitting a pull request make sure that the tests pass:
 
 ```
-  cd test/php
-  phpunit ./
+  cd build
+  make test
 ```