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

[rails.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f19b2e2673dc80def557ea7ba8c09f77e2a6bab6..e298c944f5819d2b72d8bf14cfb34e6a692de7a1 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,15 @@
+# Contributing
+

 * https://www.ruby-lang.org/ - The homepage of Ruby which has more links and some great tutorials.
 * https://rubyonrails.org/ - The homepage of Rails, also has links and tutorials.
 
 * https://www.ruby-lang.org/ - The homepage of Ruby which has more links and some great tutorials.
 * https://rubyonrails.org/ - The homepage of Rails, also has links and tutorials.
 

+## Assigning Issues
+
+We don't assign issues to individual contributors. You are welcome to work on any
+issue, and there's no need to ask first.
+
+For more details see [our FAQ](FAQ.md)]
+

 ## Coding style
 
 We use [Rubocop](https://github.com/rubocop-hq/rubocop) (for ruby files)
 ## Coding style
 
 We use [Rubocop](https://github.com/rubocop-hq/rubocop) (for ruby files)


@@ -14,6 +23,13 @@ bundle exec rails eslint
 bundle exec erblint .
 ```
 
 bundle exec erblint .
 ```
 

+You can also install hooks to have git run checks automatically when
+you commit using [overcommit](https://github.com/sds/overcommit) with:
+
+```
+bundle exec overcommit --install
+```
+

 ## Testing
 
 Having a good suite of tests is very important to the stability and
 ## Testing
 
 Having a good suite of tests is very important to the stability and


@@ -36,6 +52,12 @@ You can run the existing test suite with:
 bundle exec rails test:all
 ```
 
 bundle exec rails test:all
 ```
 

+You can run javascript tests with:
+
+```
+bundle exec teaspoon
+```
+

 You can view test coverage statistics by browsing the `coverage` directory.
 
 The tests are automatically run on Pull Requests and other commits via github
 You can view test coverage statistics by browsing the `coverage` directory.
 
 The tests are automatically run on Pull Requests and other commits via github


@@ -70,15 +92,6 @@ 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.
 
 [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.
-

 ### Copyright attribution
 
 The list of attributions on the /copyright page is managed by the [OSMF Licensing
 ### Copyright attribution
 
 The list of attributions on the /copyright page is managed by the [OSMF Licensing