merely-useful / r-rse

ARCHIVED: Activity moved to rostools organization.
Other
11 stars 5 forks source link

Idea: Use GH Actions to run spell check and re-formatting of text onto files changed in PR #16

Closed lwjohnst86 closed 1 year ago

lwjohnst86 commented 4 years ago

(This is mostly for myself and my own ideas.)

For instance, have pandoc run on Rmd to reformat text so it fits specific column width and let automation worry about style and we worry about content. (see knitr::wrap_rmd())

lwjohnst86 commented 4 years ago

Can also use an action to run spell check/linters

lwjohnst86 commented 3 years ago

Useful resource for this (and CI section): https://ropenscilabs.github.io/actions_sandbox/understanding-yaml.html

lwjohnst86 commented 3 years ago

And to add non-breaking spaces, glossary definitions, and links used (bookdown also does this with warnings... could have warnings be build errors in GH Actions).

lwjohnst86 commented 3 years ago

inspiration: https://github.com/tidyverse/dplyr/blob/master/.github/workflows/pr-commands.yaml