X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/c3d7cfd7ff90879511ff1c8b54a5d280e2e15057..aa9e9a5eb1a66c04a377f7f9f590f1c2e5e6592e:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9da33fe8c..43b74224f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -* http://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 ## Coding style @@ -6,7 +6,7 @@ When writing code it is generally a good idea to try and match your formatting to that of any existing code in the same file, or to other similar files if you are writing new code. Consistency of layout is -far more important that the layout itself as it makes reading code +far more important than the layout itself as it makes reading code much easier. One golden rule of formatting -- please don't use tabs in your code @@ -35,14 +35,10 @@ You can run the existing test suite with: bundle exec rake test ``` -You can generate test coverage stats with: +You can view test coverage statistics by browsing the `coverage` directory. -``` -sudo gem install rcov -rcov -x gems test/*/*.rb -``` - -The tests are automatically run on commit with the results shown at [http://cruise.openstreetmap.org/](http://cruise.openstreetmap.org/) +The tests are automatically run on Pull Requests and other commits with the +results shown on [Travis CI](https://travis-ci.org/openstreetmap/openstreetmap-website). ## Comments @@ -93,7 +89,6 @@ If you have forked on GitHub then the best way to submit your patches is to push your changes back to GitHub and then send a "pull request" on GitHub. Otherwise you should either push your changes to a publicly visible git repository -and send the details to the [rails-dev](http://lists.openstreetmap.org/listinfo/rails-dev) +and send the details to the [rails-dev](https://lists.openstreetmap.org/listinfo/rails-dev) list or generate patches with `git format-patch` and send them to the -[rails-dev](http://lists.openstreetmap.org/listinfo/rails-dev) list. - +[rails-dev](https://lists.openstreetmap.org/listinfo/rails-dev) list.