From: Andy Allan <git@gravitystorm.co.uk>
Date: Wed, 6 Mar 2019 10:44:59 +0000 (+0100)
Subject: Update coding style section of the contribution guide to describe our use of rubocop... 
X-Git-Tag: live~3244^2~2
X-Git-Url: https://git.openstreetmap.org./rails.git/commitdiff_plain/227e1b134def3be346fe47e951a5beb54513f600

Update coding style section of the contribution guide to describe our use of rubocop and erblint
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 43b74224f..c5a636569 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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