]> git.openstreetmap.org Git - rails.git/blobdiff - CONTRIBUTING.md
Merge remote-tracking branch 'upstream/pull/5389'
[rails.git] / CONTRIBUTING.md
index 99286692e5e7fa3dd030e79a4ac48a1d71edadd6..e298c944f5819d2b72d8bf14cfb34e6a692de7a1 100644 (file)
@@ -1,5 +1,14 @@
+# Contributing
+
 * https://www.ruby-lang.org/ - The homepage of Ruby which has more links and some great tutorials.
 * https://www.ruby-lang.org/ - The homepage of Ruby which has more links and some great tutorials.
-* http://rubyonrails.org/ - The homepage of Rails, also has links and 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
 
 
 ## Coding style
 
@@ -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,14 +92,20 @@ 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
+### Copyright attribution
+
+The list of attributions on the /copyright page is managed by the [OSMF Licensing
+Working Group (LWG)](https://wiki.osmfoundation.org/wiki/Licensing_Working_Group).
+
+If you want to add another attribution, or make changes to the text of an existing
+attribution, please follow these steps:
 
 
-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.
+* First, contact the LWG to discuss your proposed changes.
+* If the LWG approves, please create a pull request with your proposed changes.
+* Finally, please ask the LWG to formally approve the wording used in the pull request
+  (by having an LWG member comment on the PR).
 
 
-Adding or removing keys to this list is therefore discouraged, but contributions
-to the descriptive texts are welcome.
+When we have formal confirmation from LWG, we can go ahead and merge the PR.
 
 ## Committing
 
 
 ## Committing