Merge remote-tracking branch 'upstream/master'

[nominatim-ui.git] / CONTRIBUTE.md

diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
index 127cb6ea761605c6b23aeda21aa90a93c65229de..66251bebd4be950c08c25dd9fb1f86c428a49ab0 100644 (file)
--- a/CONTRIBUTE.md
+++ b/CONTRIBUTE.md
@@ -1,10 +1,13 @@
 # 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
-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,
@@ -27,6 +30,13 @@ Uses [svelte](https://svelte.dev/) framework,
    which will start a webserver on port 9880 and auto-reloads
    whenever you edit files.
 
+## Testing
+
+* Run syntax linter
+
+   ```
+   yarn lint
+   ```
 
 ## Prepare a release
 
@@ -34,10 +44,9 @@ Uses [svelte](https://svelte.dev/) framework,
 
 2. Update `CHANGES.md` file
 
-3. Run `yarn build` to make sure the `dist/build/` files don't contain lifereload.js
-
-4. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc
+3. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc
 
-5. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`
+4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`
 
-6. 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.