Merge remote-tracking branch 'upstream/pull/3573'

[rails.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 439e2e95f982b18452a261f445b7f5482d7a9c8d..aaa1b5d4b555b960d3d5a258e660c78f0ff6afe3 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -33,13 +33,21 @@ functionality.
 You can run the existing test suite with:
 
 ```
 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.
 
 ```
 
 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
 
 
 ## 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.
 
 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
 ## Committing
 
 When you submit patches, the project maintainer has to read them and