Merge pull request #328 from pwildenhain/update-contributing

- Update CONTRIBUTING.md (#328).

Author: lorenzwalthert

CONTRIBUTING.md

@@ -1,8 +1,7 @@
 # General
 
 Before making a pull request, discuss your ideas in an issue. This repo is
-experimental.
-This repo uses the [tic](https://github.com/ropenscilabs/tic) package for CI.
+maturing.
 
 # Adding new hooks
 
@@ -13,34 +12,29 @@ the script, you can expect the passed command line arguments to be all options,
 finally the files that should be processed with the hook.
 
 For the scripts to become a hook, they need to be *registered* in
-[`.pre-commit-hooks.yaml`](https://github.com/lorenzwalthert/precommit/blob/main/.pre-commit-hooks.yaml). As R is not currently a supported language of
-pre-commit (https://github.com/pre-commit/pre-commit/issues/926), most hooks use
-`language: script` and then a shebang in the `entrypoint` script.
+[`.pre-commit-hooks.yaml`](https://github.com/lorenzwalthert/precommit/blob/main/.pre-commit-hooks.yaml). As of pre-commit 2.11, R is a [supported language of
+pre-commit](https://pre-commit.com/#r). Hence, it should have `language: r` in `.pre-commit-hooks.yaml` and then (for compatibility) a shebang in the `entrypoint` script.
 
 # Testing hooks
 
 Hooks should be tested by checking both the positive outcome (hook passes) and
 the negative outcome (hook fails) by adding two `run_test()` statements to
-[`./tests/testthat/test-all.R`](https://github.com/lorenzwalthert/precommit/blob/main/tests/testthat/test-all.R). Look at existing examples and [the documentation
-of `run_test()`](https://lorenzwalthert.github.io/precommit/reference/run_test.html). Note that this won't actually use pre-commit. It will simply
-call the hook script the same way as pre-commit would, with the difference that
-the test uses a path to the `Rscript` executable whereas with pre-commit, the 
-shebang is needed. Hence, omitting the shebang in your script will indicated 
-passed tests, but this will be false positive. Also, there is no easy way to 
-test if a hook is correctly registered in `.pre-commit-hooks.yaml`
-
-For this reason, always test the hook manually end-to-end with 
-`pre-commit try-repo` as described in the 
-[documentation](https://pre-commit.com/#pre-commit-try-repo).
+[`./tests/testthat/test-hooks.R`](https://github.com/lorenzwalthert/precommit/blob/main/tests/testthat/test-hooks.R). Look at existing examples and [the documentation
+of `run_test()`](https://lorenzwalthert.github.io/precommit/reference/run_test.html). Note that this won't interact with pre-commit. It will simply
+run `Rscript path/to/script.R` (whereas with pre-commit, a {renv} will be activated before running the script). 
+
+Also, there are [tests](https://github.com/lorenzwalthert/precommit/blob/main/.github/workflows/end-to-end.yml) to ensure that hooks are correctly registered in `.pre-commit-hooks.yaml`, which you have to adapt if you add a hook. 
+
+You can also test them with `pre-commit try-repo` as described in the [documentation](https://pre-commit.com/#pre-commit-try-repo).
+
 
 # Summary
 
-- add your script to in `inst/bin` and make it executable. Only R scripts are 
-  currently supported as testing is done with `Rscript ...`.
+- add your R (with extension) script in `inst/hooks/exported` and make it executable. See other scripts in `inst/hooks/exported` for a starting point for setting up your script.
 
 - register hook in `.pre-commit-hooks.yaml`.
 
-- add two unit tests, test manually with `pre-commit try-repo`.
+- add two unit tests, test manually with `pre-commit try-repo` and adapt the [end-to-end test](https://github.com/lorenzwalthert/precommit/blob/main/.github/workflows/end-to-end.yml).
 
-- add a description of the new hook to the `README.Rmd`. Both description and
+- add a description of the new hook to `vignettes/available-hooks.Rmd`. Both description and
   `yaml` example code.