X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/2fac7a43842f186a507a176ee40a0ed5d25a3da4..c8ad2cc456e1e8a3d4c09e31fb6860955655d237:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ddd959664..2571b9345 100644 --- 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. -* 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 +14,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 +43,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,15 +83,6 @@ 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 - -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. - -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