Upgrade deprecated Github Actions

[nominatim-ui.git] / CONTRIBUTE.md

diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
index 7ef727d4c31156f26520a1ef0cbe6224682c81b5..72248321ef3327e906147149d01491fd3c016a5c 100644 (file)
--- a/CONTRIBUTE.md
+++ b/CONTRIBUTE.md
@@ -28,7 +28,7 @@ Svelte. Version 3 added theme and easier configuration.
    ```
    yarn dev
    ```
    ```
    yarn dev
    ```

-   which will start a webserver on port 9880 and auto-reloads
+   which will start a webserver on port 9080 and auto-reloads

    whenever you edit files. Configuration in `rollup.config.js`.
 
 ## Testing
    whenever you edit files. Configuration in `rollup.config.js`.
 
 ## Testing


@@ -36,13 +36,24 @@ Svelte. Version 3 added theme and easier configuration.
 The `test/` setup uses [Mocha](https://mochajs.org/) to run tests. Tests use [Puppeteer](https://pptr.dev/) to control a Google Chrome headless browser and evaluate with [Assert](https://nodejs.org/api/assert.html).
 
 
 The `test/` setup uses [Mocha](https://mochajs.org/) to run tests. Tests use [Puppeteer](https://pptr.dev/) to control a Google Chrome headless browser and evaluate with [Assert](https://nodejs.org/api/assert.html).
 
 

-* Run integration test suite (configuration in `.mocharc.js`)
+* Run integration test suite (configuration in `.mocharc.json`)

 
    ```
    yarn test
 
    ```
    yarn test

+   API_ON_SAME_PORT=1 yarn test

    ```
 
    ```
 

-* Run syntax linter (configuration in `.eslint.js`)
+   Setting API_ON_SAME_PORT simulates having both the API and UI on the same server
+   port. That's a rare setup but something https://nominatim.openstreetmap.org/ does
+   so worth testing.
+
+   To run a single test file only
+
+   ```
+   yarn run rollup -c && yarn run mocha test/details.js
+   ```
+
+* Run syntax linter (configuration in `.eslint.json`)

 
    ```
    yarn lint
 
    ```
    yarn lint


@@ -55,7 +66,7 @@ The `test/` setup uses [Mocha](https://mochajs.org/) to run tests. Tests use [Pu
 
 2. Update `CHANGES.md` file
 
 
 2. Update `CHANGES.md` file
 

-3. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc
+3. Commit your changes: `git add ... `, `git commit ...`, `git push ...` etc

 
 4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`
 
 
 4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`