Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add Rubocop configuration file #366

Merged
merged 3 commits into from
Jul 16, 2020

Conversation

RolandBurrows
Copy link
Contributor

@RolandBurrows RolandBurrows commented Oct 31, 2018

Short description of what this PR does:

  1. Running rubocop locally per the contributing guide resulted in the following:

    87 files inspected, 2736 offenses detected

    But the vast majority of those offense are located in folders excluded by the .codeclimate.yml for CI. Excluding those locally yields:

    40 files inspected, 293 offenses detected

  2. Note: that if someone runs rubocop -a to autocorrect issues:

    40 files inspected, 309 offenses detected, 236 offenses corrected

    but this touches 31 files and is likely to result in massive merge conflicts. Best to do after most major feature work is done.

  3. Note: one can run rubocop --auto-gen-config and it will generate a .rubocop_todo.yml file that documents all the spots that need repairing. But it will also change the .rubocop.yml to inherit the todo file, which then excludes the issues from being reported. Best not commit that.

Checklist

  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the [Contribution Guide] and my PR follows them.
  • I updated my branch with the master branch.
  • (N/A) I have added tests that prove my fix is effective or that my feature works
  • (N/A) I have added necessary documentation about the functionality in the appropriate .md file
  • (N/A) I have added in line documentation to the code I modified

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 31, 2018
@SendGridDX
Copy link

SendGridDX commented Oct 31, 2018

CLA assistant check
All committers have signed the CLA.

@childish-sambino childish-sambino changed the title Rubocop Local Enhancements chore: add Rubocop configuration file Jul 16, 2020
@childish-sambino childish-sambino merged commit 48f131c into sendgrid:master Jul 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: medium fix is medium in difficulty status: code review request requesting a community code review or review from Twilio
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants