X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/227e1b134def3be346fe47e951a5beb54513f600..006884beddc1c437f9599dfe12af9c1626248a4e:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5a636569..aaa1b5d4b 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 . ``` @@ -32,13 +33,21 @@ functionality. You can run the existing test suite with: ``` -bundle exec rake test +bundle exec rails test:all ``` You can view test coverage statistics by browsing the `coverage` directory. -The tests are automatically run on Pull Requests and other commits with the -results shown on [Travis CI](https://travis-ci.org/openstreetmap/openstreetmap-website). +The tests are automatically run on Pull Requests and other commits via github +actions. The results shown are within the PR display on github. + +## Static Analysis + +We also perform static analysis of our code. You can run the analysis yourself with: + +``` +bundle exec brakeman -q +``` ## Comments @@ -54,13 +63,21 @@ 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. -## Code Documentation +## i18n -To generate the HTML documentation of the API/rails code, run the command +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. -``` -rake doc:app -``` +### 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. ## Committing