chaps-io / gush

Fast and distributed workflow runner using ActiveJob and Redis
MIT License
1.05k stars 106 forks source link

Added rubocop for code style consistency #115

Closed noahfpf closed 3 months ago

noahfpf commented 4 months ago

This PR includes three commits (that can be squashed before merging):

  1. Added rubocop (and related gems) and autogenerated a config file that matches enabled cops to the existing code style. Also added rubocop step to GitHub actions.
  2. Manually disabled a few cops that depend on arbitrarily chosen lengths (e.g. Metrics/MethodLength).
  3. Enabled some cops and fixed related warnings.

For the last commit, I chose cops that were very easy to update the code to adhere to and, in some cases, relate to preventing bugs. I mostly avoided cops that involve more personal code style preferences (e.g. spacing, alignment, naming). If those changes don't follow this project's preferred styling, I'm happy to roll some or all of them back.

pokonski commented 3 months ago

This looks great! Appreciate you taking steps to minimize the changes that default Rubocop would probably generate 😁