search

instedd / cdx

Connected Diagnostics Platform
https://cdx.io
9 stars 7 forks source link

Setup Rubocop #1930

Closed bolom closed 1 year ago

bolom commented 1 year ago

Standardizing styling of a codebase across multiple developers can be tricky especially as new members are onboarded to the team.

It should run on CI and fail when not passing, but not prevent all the other tests to be run. Ideally it would report issues as GitHub annotations (e.g. https://github.com/marketplace/actions/github-rubocop-action for example).

bolom commented 1 year ago

@ysbaddaden Sentry is already added? I've seen sentry-raven in Gemfile

ysbaddaden commented 1 year ago

Yes, Sentry is already setup, but never catches anything (it might not be configured in Radx production or we did a perfect job). We must also be very careful with what's reported as it can easily leak sensitive private patient data.

I extracted Brakeman to its own issue.

I'm rather fond of the standard gem which has somewhat good defaults. It even promotes double quotes for strings :raised_hands: which reduces friction with languages such as Crystal, Erlang, Rust or plain C, among other issues.