diff options
| author | Giorgenes Gelatti <ggelatti@gitlab.com> | 2019-09-02 08:38:27 +0300 |
|---|---|---|
| committer | Thong Kuah <tkuah@gitlab.com> | 2019-09-02 08:38:27 +0300 |
| commit | 2fb6c9f3c74b174f926aaaeae33ee14b4cba8195 (patch) | |
| tree | 3cb903c35d5f1f3fb3395cb0f31b43ff3ba3952b /doc/development/contributing | |
| parent | cd8d008cb95ce2321b7cdb36433ff40375043ce9 (diff) | |
Adds basic overcommit support
Diffstat (limited to 'doc/development/contributing')
| -rw-r--r-- | doc/development/contributing/style_guides.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md index 7832850a9f0..f825b3d7088 100644 --- a/doc/development/contributing/style_guides.md +++ b/doc/development/contributing/style_guides.md @@ -25,8 +25,13 @@ 1. [Python](../python_guide/index.md) 1. [Shell scripting](../shell_scripting_guide/index.md) +## Checking the style and other issues + 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. +This saves you time as you don't have to wait for the same errors to be detected by the CI. --- |