]> git.openstreetmap.org Git - rails.git/blobdiff - CONTRIBUTING.md
Move api error handling and timeouts to parent class
[rails.git] / CONTRIBUTING.md
index 9e878a30cfc455bf98a502e2aba6ad57951dcb3e..383e793b38495570fe0f8311390e63778b2d7d03 100644 (file)
@@ -1,5 +1,5 @@
 * 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
 
@@ -10,10 +10,17 @@ development to check that your code matches our guidelines:
 
 ```
 bundle exec rubocop
-bundle exec rake eslint
+bundle exec rails eslint
 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
@@ -79,6 +86,21 @@ 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
+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:
+
+* 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).
+
+When we have formal confirmation from LWG, we can go ahead and merge the PR.
+
 ## Committing
 
 When you submit your changes, the project maintainers have to read them and