Update coding style section of the contribution guide to describe our use of rubocop...
authorAndy Allan <git@gravitystorm.co.uk>
Wed, 6 Mar 2019 10:44:59 +0000 (11:44 +0100)
committerTom Hughes <tom@compton.nu>
Tue, 26 Mar 2019 20:52:43 +0000 (20:52 +0000)
CONTRIBUTING.md

index 43b74224fae6b88aa09495e0a2f12beb94cc44f6..c5a63656981a0ebd8bf8ba3b7eca24bf4f33735f 100644 (file)
@@ -3,15 +3,15 @@
 
 ## Coding style
 
-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 than the layout itself as it makes reading code
-much easier.
-
-One golden rule of formatting -- please don't use tabs in your code
-as they will cause the file to be formatted differently for different
-people depending on how they have their editor configured.
+We use [Rubocop](https://github.com/rubocop-hq/rubocop) (for ruby files)
+and [ERB Lint](https://github.com/Shopify/erb-lint) (for erb templates)
+to help maintain consistency in our code. You can run these utilities during
+development to check that your code matches our guidelines:
+
+```
+bundle exec rubocop
+bundle exec erblint .
+```
 
 ## Testing