The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.
Pre-commit hooks are tests that run each time you attempt to commit. If the tests pass, the commit will be made, otherwise not. A very basic test is to check if the code is parsable, making sure you have not forgotten a comma, brace or quote. You can run hooks locally and/or in the cloud:
As a check before local commits: This requires installing pre-commit.
As a CI check with https://pre-commit.ci: If you want to enforce passing hooks on pull requests (and auto-fix trivial problems like styling) even if the committer does not have a local installation.
The goal of this package is to twofold:
Provide a set of hooks that are useful when your git repo contains R code.
Provide usethis-like functionality for common tasks such as installation and set-up and config file modification.
For a more in-depth explanation and even more reasons, see
vignette("why-use-hooks").
The following online docs are available:
These only cover the functionality added on top of the pre-commit
framework by this package. Everything else is covered in the extensive
online documentation of the
pre-commit framework itself, including how to create hooks for actions
like git push or git checkout, create local
hooks etc.
These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.