update release instructions

[nominatim.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 757c52b7c2f8916382bfced2ff2b639d9fdfe4d1..b9bf2920e1c689cd29937b5c699c98ce3cc26f17 100644 (file)
--- 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.
 
 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
 ## 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
    * 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
 ```
 
 ## Testing


@@ -61,8 +71,7 @@ pylint3 --extension-pkg-whitelist=osmium nominatim
 Before submitting a pull request make sure that the tests pass:
 
 ```
 Before submitting a pull request make sure that the tests pass:
 
 ```

-  cd build
-  make test
+  make tests

 ```
 
 ## Releases
 ```
 
 ## Releases


@@ -83,13 +92,14 @@ Checklist for releases:
 * [ ] complete `docs/admin/Migration.md`
 * [ ] update EOL dates in `SECURITY.md`
 * [ ] commit and make sure CI tests pass
 * [ ] complete `docs/admin/Migration.md`
 * [ ] update EOL dates in `SECURITY.md`
 * [ ] commit and make sure CI tests pass

+* [ ] update OSMF production repo and release new version -post1 there

 * [ ] test migration
   * download, build and import previous version
   * migrate using master version
   * run updates using master version
 * [ ] prepare tarball:
 * [ ] test migration
   * download, build and import previous version
   * migrate using master version
   * run updates using master version
 * [ ] prepare tarball:

-  * `git clone --recursive https://github.com/osm-search/Nominatim` (switch to right branch!)
-  * `rm -r .git* osm2pgsql/.git*`
+  * `git clone https://github.com/osm-search/Nominatim` (switch to right branch!)
+  * `rm -r .git*`

   * copy country data into `data/`
   * add version to base directory and package
 * [ ] upload tarball to https://nominatim.org
   * copy country data into `data/`
   * add version to base directory and package
 * [ ] upload tarball to https://nominatim.org