Feat: Added testing to Github actions and updated documentation (#133)

[nominatim-ui.git] / CONTRIBUTE.md

diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
index e8c56e3b08d4c10c8be20cfe0ecdd3ecaa4344d0..8c63196ccd71391fdea432372d736201a2d28b5d 100644 (file)
--- a/CONTRIBUTE.md
+++ b/CONTRIBUTE.md
@@ -38,16 +38,21 @@ Uses [svelte](https://svelte.dev/) framework,
    yarn lint
    ```
 
+* Run mocha test suite
+
+   ```
+   yarn test
+   ```
+
 ## Prepare a release
 
 1. Update version number in `package.json` file
 
 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.