search

epiverse-trace / blueprints

Software development blueprints for epiverse-trace
https://epiverse-trace.github.io/blueprints
Other
3 stars 3 forks source link

Mention the use of goodpractice R package for code quality #38

Closed jamesmbaazam closed 1 year ago

jamesmbaazam commented 1 year ago

Under the section on code reviews, we mention the use of lintr and styler. It might be worthwhile to also mention goodpractice, which basically calls most of the other automations (cover, lintr, etc) in one line of code and provides useful feedback for improving the code.

I can submit a PR to close this.

Bisaloo commented 1 year ago

Yes, a PR would be great thanks!

Ideally, we would also have a complete page of "code reviews in practice" based on the notes we have from the all-RSEs meetings and this page would be linked from the "general principles" page.

But your suggestion is a concise and immediate improvement so let's start with this.

jamesmbaazam commented 1 year ago

That's a good idea. We can move things around when we have fleshed this out. I would argue that Code Reviews should fall under the broader topic of Code Quality.