X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/46a10cf8146e16d9da7bb21e5976d9c62b69fdd1..c3b318afea1dd2cebf1d46dce781ee545f6698f0:/CONTRIBUTING.md?ds=sidebyside diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8baadb28..a78bbfb3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,21 +61,23 @@ pylint3 --extension-pkg-whitelist=osmium nominatim Before submitting a pull request make sure that the tests pass: ``` - cd build - make test + make tests ``` ## Releases Nominatim follows semantic versioning. Major releases are done for large changes that require (or at least strongly recommend) a reimport of the databases. -Minor releases can usually be applied to exisiting databases. Patch releases +Minor releases can usually be applied to existing databases. Patch releases contain bug fixes only and are released from a separate branch where the relevant changes are cherry-picked from the master branch. Checklist for releases: -* [ ] increase version in `nominatim/version.py` and CMakeLists.txt +* [ ] increase versions in + * `src/nominatim_api/version.py` + * `src/nominatim_db/version.py` + * CMakeLists.txt * [ ] update `ChangeLog` (copy information from patch releases from release branch) * [ ] complete `docs/admin/Migration.md` * [ ] update EOL dates in `SECURITY.md` @@ -100,3 +102,4 @@ Checklist for releases: * compile and import Nominatim * run `nominatim --version` to confirm correct version * [ ] tag new release and add a release on github.com +* [ ] build pip packages and upload to pypi