X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/5977c47851bff05c13ea7a6030b4301e1f50efa1..0348ceb3d72af260c0dce0013ab2cc59f2203d97:/CONTRIBUTING.md 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