X-Git-Url: https://git.openstreetmap.org/nominatim.git/blobdiff_plain/b5fc5e0a71f73f2cafde441b54edcbb7610d45d7..908c66ca84d8f321911aa93d69a8f311ee8dd347:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efd5315d..242a9d6f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,16 +30,18 @@ Please make sure to add the following information: 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 - * Nominatim version (commit id, if you run from the github repo) - * (if applicable) exact command line of the command that was causing the issues + * 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 @@ -63,7 +65,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 @@ -80,7 +82,7 @@ are in process of consolodating the style. The following rules apply: The coding style is enforced with PHPCS and can be tested with: ``` - phpcs --report-width=120 --colors */**.php + phpcs --report-width=120 --colors . ``` ## Testing