X-Git-Url: https://git.openstreetmap.org./nominatim-ui.git/blobdiff_plain/345dd95966aa46acba71ab4eb701851b1771b0e5..a6e3425fd49331782c847b18668ad12ee5984d08:/CONTRIBUTE.md diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 11adf81..66251be 100644 --- 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, @@ -24,9 +27,16 @@ Uses [svelte](https://svelte.dev/) framework, ``` 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. +## 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.