version v3.0.2

[nominatim-ui.git] / CONTRIBUTE.md

diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
index 0f7abc18d0bdbef28319b9b3bd704f42c46a9b6f..66251bebd4be950c08c25dd9fb1f86c428a49ab0 100644 (file)
--- a/CONTRIBUTE.md
+++ b/CONTRIBUTE.md
@@ -1,10 +1,13 @@
 # Developing Nominatim-UI
 
 # Developing Nominatim-UI
 

+[![Continuous Integration](https://github.com/osm-search/nominatim-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/osm-search/nominatim-ui/actions/workflows/ci.yml)
+

 ## Background
 
 The user interface used to be included in the geocoder. Thus the
 first version avoid being a redesign and still uses some of the
 ## Background
 
 The user interface used to be included in the geocoder. Thus the
 first version avoid being a redesign and still uses some of the

-same configuration values.
+same configuration values. Version 2 was a full refactor using
+Svelte. Version 3 added theme and easier configuration.

 
 Uses [svelte](https://svelte.dev/) framework,
 [leaflet](https://leafletjs.com/) for map interaction,
 
 Uses [svelte](https://svelte.dev/) framework,
 [leaflet](https://leafletjs.com/) for map interaction,


@@ -24,9 +27,16 @@ Uses [svelte](https://svelte.dev/) framework,
    ```
    yarn dev
    ```
    ```
    yarn dev
    ```

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

    whenever you edit files.
 
    whenever you edit files.
 

+## Testing
+
+* Run syntax linter
+
+   ```
+   yarn lint
+   ```

 
 ## Prepare a release
 
 
 ## Prepare a release
 


@@ -38,4 +48,5 @@ Uses [svelte](https://svelte.dev/) framework,
 
 4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`
 
 
 4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`
 

-5. Upload release
\ No newline at end of file
+5. 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.