Merge remote-tracking branch 'upstream/pull/3293'

[rails.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 43b74224fae6b88aa09495e0a2f12beb94cc44f6..474c80b4f6eb3f6c6f293b8f47902f703ae7b3bc 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,15 +3,16 @@
 
 ## Coding style
 
 
 ## Coding style
 

-When writing code it is generally a good idea to try and match your
-formatting to that of any existing code in the same file, or to other
-similar files if you are writing new code. Consistency of layout is
-far more important than the layout itself as it makes reading code
-much easier.
+We use [Rubocop](https://github.com/rubocop-hq/rubocop) (for ruby files)
+and [ERB Lint](https://github.com/Shopify/erb-lint) (for erb templates)
+to help maintain consistency in our code. You can run these utilities during
+development to check that your code matches our guidelines:

 
 

-One golden rule of formatting -- please don't use tabs in your code
-as they will cause the file to be formatted differently for different
-people depending on how they have their editor configured.
+```
+bundle exec rubocop
+bundle exec rake eslint
+bundle exec erblint .
+```

 
 ## Testing
 
 
 ## Testing
 


@@ -32,7 +33,7 @@ functionality.
 You can run the existing test suite with:
 
 ```
 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.
 ```
 
 You can view test coverage statistics by browsing the `coverage` directory.


@@ -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