Merge branch 'pull/3472'

[rails.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index df2001b0ab025effedd38df5573781239451d954..aaa1b5d4b555b960d3d5a258e660c78f0ff6afe3 100644 (file)
--- 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
 
@@ -61,13 +70,14 @@ 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.
 
-## Code Documentation
+### Nominatim prefixes
 
-To generate the HTML documentation of the API/rails code, run the command
+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.
 
-```
-rake doc:app
-```
+Adding or removing keys to this list is therefore discouraged, but contributions
+to the descriptive texts are welcome.
 
 ## Committing