]> git.openstreetmap.org Git - nominatim-ui.git/blobdiff - CONTRIBUTE.md
Add build output into dist/ for immediate use
[nominatim-ui.git] / CONTRIBUTE.md
index c9103379afcef2456ae26ca98632507fe56301e1..bef0e99d3a1815614b563171ff67475edbfec263 100644 (file)
@@ -28,7 +28,7 @@ Svelte. Version 3 added theme and easier configuration.
    ```
    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
@@ -36,7 +36,7 @@ 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).
 
 
-* Run integration test suite (configuration in `.mocharc.js`)
+* Run integration test suite (configuration in `.mocharc.json`)
 
    ```
    yarn test
@@ -53,7 +53,7 @@ The `test/` setup uses [Mocha](https://mochajs.org/) to run tests. Tests use [Pu
    yarn run rollup -c && yarn run mocha test/details.js
    ```
 
-* Run syntax linter (configuration in `.eslint.js`)
+* Run syntax linter (configuration in `.eslint.json`)
 
    ```
    yarn lint
@@ -62,13 +62,15 @@ The `test/` setup uses [Mocha](https://mochajs.org/) to run tests. Tests use [Pu
 
 ## Prepare a release
 
-1. Update version number in `package.json` file
+1. Create build (dist/bundle/ files): `yarn build`
 
-2. Update `CHANGES.md` file
+2. Update version number in `package.json` file
 
-3. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc
+3. Update `CHANGES.md` file
 
-4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`
+4. Commit your changes: `git add ... `, `git commit ...`, `git push ...` etc
 
-5. Create release on https://github.com/osm-search/nominatim-ui/releases
+5. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`
+
+6. Create release on https://github.com/osm-search/nominatim-ui/releases
    This (a triggered Github Action) will run `yarn build` and add the `dist/build/bundle.*` files.