Allow OAuth 2 authorizations to redirect to anywhere

[rails.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c5a63656981a0ebd8bf8ba3b7eca24bf4f33735f..568566c17ed8ba00e7019214486c7d864fe90a48 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 rubocop

+bundle exec rake eslint

 bundle exec erblint .
 ```
 
 bundle exec erblint .
 ```
 


@@ -40,6 +41,14 @@ 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 with the
 results shown on [Travis CI](https://travis-ci.org/openstreetmap/openstreetmap-website).
 

+## Static Analysis
+
+We also perform static analysis of our code. You can run the analysis yourself with:
+
+```
+bundle exec brakeman -q
+```
+

 ## Comments
 
 Sometimes it's not apparent from the code itself what it does, or,
 ## Comments
 
 Sometimes it's not apparent from the code itself what it does, or,


@@ -54,6 +63,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.
 
 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
 ## Code Documentation
 
 To generate the HTML documentation of the API/rails code, run the command