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

[rails.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 99286692e5e7fa3dd030e79a4ac48a1d71edadd6..46fe63bb2b101595fe02b0ea2fb40e43f0553a40 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,14 @@
+# Contributing
+
 * 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
 
@@ -11,7 +20,14 @@ development to check that your code matches our guidelines:
 ```
 bundle exec rubocop
 bundle exec rails eslint
-bundle exec erblint .
+bundle exec erb_lint .
+```
+
+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
@@ -36,6 +52,12 @@ You can run the existing test suite with:
 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
@@ -65,19 +87,25 @@ and why it should be the way it is.
 
 ## i18n
 
-If you make a change that involve the locale files (in `config/locales`) then please
+If you make a change that involves 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
+### 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
 
@@ -115,7 +143,7 @@ with making the reviews as straightforward as possible:
   large to review in one sitting, or if changes are requested, then the
   maintainer needs to repeatedly re-read code that has already been considered.
 * The commit history is important. This is a large codebase, developed over many
-  years by many developers. We frequently need to read the commit history (e.g.
+  years by many developers. We frequently need to read the commit history (for example
   using `git blame`) to figure out what is going on. So small, understandable,
   and relevant commits are important for other developers looking back at your
   work in future.