osm-search/Nominatim
1
1
Fork 0
mirror of https://github.com/osm-search/Nominatim.git synced 2024-11-22 12:06:27 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3580 from lonvia/about-ai-prs

Browse Source 
Contributions: some additional rules for AI use
This commit is contained in:
Sarah Hoffmann 2024-11-11 10:12:36 +01:00 committed by GitHub
commit 5ec07321d4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@ -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 an issue first or comment on the appropriate issue already existing so
that duplicate work can be avoided. 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 ## Coding style
Nominatim historically hasn't followed a particular coding style but we Nominatim historically hasn't followed a particular coding style but we
@ -46,13 +59,10 @@ are in process of consolidating the style. The following rules apply:
* no spaces after opening and before closing bracket * no spaces after opening and before closing bracket
* leave out space between a function name and bracket * leave out space between a function name and bracket
but add one between control statement(if, while, etc.) 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 pylint. It can be tested with:
``` ```
phpcs --report-width=120 --colors .
pylint3 --extension-pkg-whitelist=osmium nominatim pylint3 --extension-pkg-whitelist=osmium nominatim
``` ```