Merge remote-tracking branch 'upstream/master'

[nominatim.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7ebd6b9dc9c9835f888000d2a2c8aaac6a154b54..89b76e3b18e8f098987fe0a47b1b98ce06ccf5e2 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -15,9 +15,9 @@ Please make sure to add the following information:
  * 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
  * 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:
- 
+
+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
  * go to https://openstreetmap.org
  * zoom to the area of the map where you expect the result and
    zoom in as much as possible


@@ -26,21 +26,25 @@ Please make sure to add the following information:
  * 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
 
  * 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...
+### When Reporting Bugs...

 
 Please add the following information to your issue:
 
 
 Please add the following information to your issue:
 

- * hardware configuration: RAM size, kind of disks
- * Operating system (also mention if you are running on a cloud server)
+ * 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
  * Postgres and Postgis version
  * list of settings you changed in your Postgres configuration

- * Nominatim version (commit id, if you run from the github repo)
- * (if applicable) exact command line of the command that was causing the issues
+ * 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

 
 

+Bug reports that do not include extensive information about your system,
+about the problem and about what you have been trying to debug the problem
+will be closed.

 
 ## 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


@@ -64,7 +68,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


@@ -77,11 +81,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