X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/3734f1d0b84c642ba89b5a4c39bac845f5627be7..e0318344f64a9df0d32150115cee2bbf7fb9d322:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 757c52b7..78c4dd67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,6 +30,19 @@ 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. +### Using AI-assisted code generators + +PRs that include AI-generated content, may that be in code, in the PR +description or in documentation need to + +1. clearly mark the AI-generated sections as such, for example, by + mentioning all use of AI in the PR description, and +2. include proof that you have run the generated code on an actual + installation of Nominatim. Adding and excuting tests will not be + sufficient. You need to show that the code actually solves the problem + the PR claims to solve. + + ## Coding style Nominatim historically hasn't followed a particular coding style but we @@ -46,14 +59,11 @@ are in process of consolidating 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 pylint. It can be tested with: +The coding style is enforced with flake8. It can be tested with: ``` -phpcs --report-width=120 --colors . -pylint3 --extension-pkg-whitelist=osmium nominatim +make lint ``` ## Testing @@ -61,8 +71,7 @@ pylint3 --extension-pkg-whitelist=osmium nominatim Before submitting a pull request make sure that the tests pass: ``` - cd build - make test + make tests ``` ## Releases