Add :eyes: checks as well as just :heavy_check_mark: and :heavy_multiplication_x:

mpadge commented 2 years ago

Checks like the latest unique_fn_names #142 might be better changed from currently unavoiable failure:

to a new section at the bottom of the summary:

Thoughts @maelle:question:

maelle commented 2 years ago

I agree on the idea but am not sure the emoji is optimal. Maybe a warning sign or some sort of notebook?

assignUser commented 2 years ago

I was actually about to comment this on the closed issue! ⚠️ 🗒️ 📓 👀 👁️ 👁️‍🗨️

I think 👀 communicates the intent the best?

maelle commented 2 years ago

oh yeah, good idea!

mpadge commented 2 years ago

Whatever we decide, it also needs to be translated into corresponding HTML, which i do something like:

Text search on this GitHub emoji reference page
Locate same emoji on this page to ensure it'll look the same / okay, and find the hex code.
Finally, search for same hex code on this page to find the HTML code.

Doing that gives this: :eyes: 👀, where the latter is 👀. Phew :sweat:

mpadge commented 2 years ago

Sample output:

Checks for \<some test package>

git hash: 00c38b8d

:heavy_check_mark: Package is already on CRAN.
:heavy_check_mark: has a 'codemeta.json' file.
:heavy_check_mark: has a 'contributing' file.
:heavy_multiplication_x: The following functions have no documented return values: [boot_ssc, pval, teststat]
:heavy_check_mark: uses 'roxygen2'.
:heavy_check_mark: 'DESCRIPTION' has a URL field.
:heavy_check_mark: 'DESCRIPTION' has a BugReports field.
:heavy_check_mark: Package has at least one HTML vignette
:heavy_check_mark: All functions have examples.
:heavy_multiplication_x: Package uses global assignment operator ('<<-').
:heavy_check_mark: Package has continuous integration checks.
:eyes: Function names are duplicated in other packages

Important: All failing checks above must be addressed prior to proceeding

(Checks marked with :eyes: may be optionally addressed.)

Package License: GPL-3

At the moment, only the "function names are duplicated" check generates :eyes: on fail, but trivial to re-arrange or add any others at any time. The definitions are in: https://github.com/ropensci-review-tools/pkgcheck/blob/65636586db846772d76b41609400efd0805a561a/R/summarise-checks.R#L136-L155

assignUser commented 2 years ago

Love it 👀

mpadge commented 2 years ago

Cool, thanks. It's already deployed too, so should appear anytime now ...