X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/12168e3ca9421ab1d0195507919c26ce029ce155..a4ba79fe780e521cb3f1958dd1a22238b85aa9f5:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc5be190..89b76e3b 100644 --- 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 - - 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 @@ -26,7 +26,7 @@ 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 -### When Reporting Problems with your Installation... +### When Reporting Bugs... Please add the following information to your issue: @@ -38,10 +38,13 @@ Please add the following information to your issue: 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 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 +68,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,6 +81,8 @@ 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: