X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/c82fdf8e0fd4e5a8f2d831592d5e1fe13e1fe558..979a474c682c894125e0fe9ddfc5bae566ad895c:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5a636569..439e2e95f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,7 @@ development to check that your code matches our guidelines: ``` bundle exec rubocop +bundle exec rake eslint bundle exec erblint . ``` @@ -54,6 +55,22 @@ might be difficult to understand what the code does, why it does it and why it should be the way it is. * Check existing comments to ensure that they are not misleading. +## i18n + +If you make a change that involve the locale files (in `config/locales`) then please +only submit changes to the `en.yml` file. The other files are updated via +[Translatewiki](https://translatewiki.net/wiki/Translating:OpenStreetMap) and should +not be included in your pull request. + +### Nominatim prefixes + +I18n keys under the `geocoder.search_osm_nominatim` keyspace are managed by the +Nominatim maintainers. From time to time they run stats over the Nominatim +database, and update the list of available keys manually. + +Adding or removing keys to this list is therefore discouraged, but contributions +to the descriptive texts are welcome. + ## Code Documentation To generate the HTML documentation of the API/rails code, run the command