Coding Style

We are using rubocop as a code style checker in our test suite. You can run it outside the continuous integration cycle with

bundle exec rubocop

You can learn more about the currently enabled rules in the .rubocop.yml file.

Documentation about the defined rules can be found in modules Cop::Lint and Cop::Style and Cop:Rails. Additionally you can read through the ruby style-guide to better understand core principles.

Rubocop Git Hooks

We use overcommit to automate Rubocop in pre-commit git hooks. You can activate it locally with:

1. Install overcommit gem

gem install overcommit

2. Activate overcommit

overcommit install

You can read through the current enabled hooks in the .overcommit.yml file.