Add local linting instruction to README

samg · Oct 19, 2021 · cf40efb · cf40efb
1 parent 014eb17
commit cf40efb
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -548,6 +548,12 @@ Or run the test suite:
 
     bundle exec rspec
 
+We do make use of Rubocop with StandardRB rules.
+You can lint the project locally as follows:
+    bundle exec rubocop
+Or to ignore offences that still need fixing:
+    bundle exec rubocop -c .rubocop_with_todo.yml
+
 Special Thanks
 --------------