diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-02-02 23:41:09 -0700 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-02-02 23:41:09 -0700 |
| commit | e61e608ca8ff6ddd849d4db7a842d1af7b084375 (patch) | |
| tree | 48d748641e69f0a1627298c7d05c890cd6d8b8c0 /CONTRIBUTING-CODE.adoc | |
| parent | f35321e393edcd17452066080cd561799ee24804 (diff) | |
add section to contributing guide about how to run the code linter [skip ci]
Diffstat (limited to 'CONTRIBUTING-CODE.adoc')
| -rw-r--r-- | CONTRIBUTING-CODE.adoc | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING-CODE.adoc b/CONTRIBUTING-CODE.adoc index 643a81d1..08114bdd 100644 --- a/CONTRIBUTING-CODE.adoc +++ b/CONTRIBUTING-CODE.adoc @@ -232,6 +232,17 @@ or These instructions work for testing any development version of {project-name} directly from GitHub. +=== Run the Code Linter + +Before you commit code, you should run it through the linter to make sure it adheres to the coding style. +You can run the linter using the following command: + + $ bundle exec rake lint + +The coding style is enforced by https://rubocop.org/[RuboCop]. +The rules are defined in [.path]_.rubocop.yml_. +These rules extend from the default rule set to match the style of the project. + === Generate Code Coverage Report To generate a code coverage report when running tests using simplecov, set the `COVERAGE` environment variable as follows when running the tests: |