Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 1.46 KB

code_style.md

File metadata and controls

23 lines (17 loc) · 1.46 KB
Raw

Code Style

We use RuboCop which generally enforces the Ruby Style Guide. We use a .rubocop.yml file for customized style configuration.

The current strategy is to fix the offenses either manually (if your changes are small enough) or fix them automated by running rubocop --auto-correct on the file(s) you changed. However, if you decide to run rubocop --auto-correct on the whole file(s), make sure to have a separate commit for the reformatting so that your actual commit is not polluted with code reformatting. You could do this in one of two ways:

  1. skipping the hook
  • git commit --no-verify for your code change
  • rubocop --auto-correct on the file you changed
  • do the commit for the reformatted file
  1. reformatting the file before you commit your changes
  • stash your changes
  • rubocop --auto-correct on the file you're about to change
  • do the commit for the reformatted file
  • reapply your changes
  • rubocop --auto-correct on the file
  • commit your changes

It's currently not possible to run rubocop -a on the whole repo since it's breaking some of our tests and makes it difficult for feature branches to be rebased onto master.

Our code style is still evolving, however rake rubocop is run by Travis so making these pass will improve the chances that the pull request will be accepted.