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

[rails.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5ee4e01736634679b6f233323ca41db878c653ea..2571b93459147e8e635302b24353465b63da8887 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,5 @@
 * 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.

 
 ## Coding style
 
 
 ## Coding style
 


@@ -10,14 +10,21 @@ development to check that your code matches our guidelines:
 
 ```
 bundle exec rubocop
 
 ```
 bundle exec rubocop

-bundle exec rake eslint
+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

-maintainability of any code base. The tests in the Rails port code are
+maintainability of any code base. The tests in the `openstreetmap-website` code are

 by no means complete, but they are extensive, and must continue to be
 so with any new functionality which is written. Tests are also useful
 in giving others confidence in the code you've written, and can
 by no means complete, but they are extensive, and must continue to be
 so with any new functionality which is written. Tests are also useful
 in giving others confidence in the code you've written, and can


@@ -36,6 +43,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 +83,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