diff options
Diffstat (limited to 'doc/development/contributing/style_guides.md')
| -rw-r--r-- | doc/development/contributing/style_guides.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md index d53675cc716..33c872cbb93 100644 --- a/doc/development/contributing/style_guides.md +++ b/doc/development/contributing/style_guides.md @@ -30,7 +30,9 @@ This is also the style used by linting tools such as [RuboCop](https://github.com/rubocop-hq/rubocop) and [Hound CI](https://houndci.com). You can run RuboCop by hand or install a tool like [Overcommit](https://github.com/sds/overcommit) to run it for you. -Overcommit will automatically run the configured checks (like Rubocop) on every modified file before commit. You can use the example overcommit configuration found in `.overcommit.yml.example` as a quickstart. + +Overcommit will automatically run the configured checks (like Rubocop) on every modified file before commit. +You can use the example overcommit configuration found in `.overcommit.yml.example` as a quickstart. This saves you time as you don't have to wait for the same errors to be detected by the CI. --- |