X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/3ff8ef52b71d544e6660ea7823a43397165cd180..42224790b56acea5c653f3085c374f28d56e590d:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99286692e..539aaa5cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ +# 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. ## Coding style @@ -14,6 +16,13 @@ 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 @@ -36,6 +45,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 @@ -70,14 +85,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. -### 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