details page: differentiate between spheric distance and distance in meters

[nominatim.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 276137f6d9c9b0c8ace6ac8832f42460a46b8d6d..89b76e3b18e8f098987fe0a47b1b98ce06ccf5e2 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,19 +1,74 @@
 # Nominatim contribution guidelines
 
 # Nominatim contribution guidelines
 

-## Workflow
+## Reporting Bugs

 
 

-We operate the "Fork & Pull" model explained at
+Bugs can be reported at https://github.com/openstreetmap/Nominatim/issues.
+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 Bugs...
+
+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
+
+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
+
+We love to get pull requests from you. We operate the "Fork & Pull" model
+explained at

 
 https://help.github.com/articles/using-pull-requests
 
 You should fork the project into your own repo, create a topic branch
 there and then make one or more pull requests back to the openstreetmap repository.
 
 https://help.github.com/articles/using-pull-requests
 
 You should fork the project into your own repo, create a topic branch
 there and then make one or more pull requests back to the openstreetmap repository.

-Your pull requests will then be reviewed and discussed.
+Your pull requests will then be reviewed and discussed. Please be aware
+that you are responsible for your pull requests. You should be prepared
+to get change requests because as the maintainers we have to make sure
+that your contribution fits well with the rest of the code. Please make
+sure that you have time to react to these comments and amend the code or
+engage in a conversion. Do not expect that others will pick up your code,
+it will almost never happen.
+
+Please open a separate pull request for each issue you want to address.
+Don't mix multiple changes. In particular, don't mix style cleanups with
+feature pull requests. If you plan to make larger changes, please open
+an issue first or comment on the appropriate issue already existing so
+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


@@ -26,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