X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/57c73a25bd0258c57f8315435ae05998ac3a2b36..779167e493d3163138e1bdde2982ee9f6402da14:/CONTRIBUTING.md?ds=inline diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 439e2e95f..aaa1b5d4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,13 +33,21 @@ functionality. You can run the existing test suite with: ``` -bundle exec rake test +bundle exec rails test:all ``` You can view test coverage statistics by browsing the `coverage` directory. -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). +The tests are automatically run on Pull Requests and other commits via github +actions. The results shown are within the PR display on github. + +## Static Analysis + +We also perform static analysis of our code. You can run the analysis yourself with: + +``` +bundle exec brakeman -q +``` ## Comments @@ -71,14 +79,6 @@ 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. -## Code Documentation - -To generate the HTML documentation of the API/rails code, run the command - -``` -rake doc:app -``` - ## Committing When you submit patches, the project maintainer has to read them and