Merge pull request #644 from lorenzwalthert/document-precommit

- Document how to use precommit (#644).

Author: lorenzwalthert

.pre-commit-config.yaml

@@ -2,20 +2,51 @@
 # R specific hooks: https://github.com/lorenzwalthert/precommit
 repos:
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.0.0.9040
+    rev: v0.1.0
     hooks:
-    -   id: parsable-R
-    -   id: no-browser-statement
-    # -   id: lintr
-    -   id: readme-rmd-rendered
-    -   id: spell-check
     -   id: style-files
         args: [--style_pkg=styler, --style_fun=tidyverse_style]
         exclude: 'tests/testthat/.*/*\.R'
+    -   id: roxygenize
+    -   id: use-tidy-description
+    -   id: spell-check
+        exclude: >
+          (?x)^(
+          data/.*|
+          (.*/|)\.Rprofile|
+          (.*/|)\.Renviron|
+          (.*/|)\.gitignore|
+          (.*/|)NAMESPACE|
+          (.*/|)WORDLIST|
+          (.*/|)\.travis.yml|
+          (.*/|)appveyor.yml|
+          (.*/|)\.Rbuildignore|
+          (.*/|)\.pre-commit-.*|
+          .*\.[rR]|
+          .*\.Rproj|
+          .*\.py|
+          .*\.feather|
+          .*\.rds|
+          .*\.Rds|
+          .*\.sh|
+          .*\.RData
+          )$
+    -   id: readme-rmd-rendered
+    -   id: parsable-R
+    -   id: no-browser-statement
+    -   id: deps-in-desc
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.5.0
     hooks:
     -   id: check-added-large-files
         args: ['--maxkb=200']
     -   id: end-of-file-fixer
         exclude: '\.Rd'
+-   repo: local
+    hooks:
+    -   id: forbid-to-commit
+        name: Don't commit common R artifacts
+        entry: Cannot commit .Rhistory, .RData, .Rds or .rds.
+        language: fail
+        files: '\.Rhistory|\.RData|\.Rds|\.rds$'
+        # `exclude: <regex>` to allow committing specific files.

CONTRIBUTING.md

@@ -4,6 +4,19 @@ This project follows the contributing recommendations outlined by [saamwerk](htt
 In particular, issues labelled with `Status: Postponed` are closed even if they
 are not resolved.
 
+## Contributing code
+
+* Only open a PR when your idea was approved of by a contributor in an issue.
+* Add a bullet to NEWS.md referencing the PR, also following the guide lines in 
+  [tidyverse style guide](http://style.tidyverse.org), as for your code 
+  contributions.
+* Make sure your commit pass the pre-commit hooks in this repo. See the 
+  `{precommit}` [README.md](https://github.com/lorenzwalthert/precommit) 
+  on how to install the pre-commit framework and the R package on your system and 
+  then run `precommit::use_precommit()` to make sure the hooks are activated 
+  in your local styler clone. If you skip a hook, describe why in the PR. 
+
+
 ## How to dive in and understanding the source code
 
 Read the vignettes. If you are done, come back here.
@@ -191,10 +204,3 @@ used to track failed tests.
 The files are placed in `tests/testthat` under the category they fit. 
 Please have a look at the documentation for `test_collection()` and see other 
 unit tests. Let me know if there is anything unclear about this.
-
-## Contributing code
-
-* Only open a PR when your idea was approved of by a contributor in an issue.
-* Add a bullet to NEWS.md referencing the PR, also following the guide lines in 
-  [tidyverse style guide](http://style.tidyverse.org), as for your code 
-  contributions.

README.Rmd

@@ -174,3 +174,15 @@ styler functionality is made available through other tools, most notably
   or the [pkgdown](https://r-lib.github.io/styler/) page contain information
   related to the initial development phase during Google Summer of Code 2017.
 
+## Contributing
+
+Please have a look at `CONTRIBUTING.md`, in particular, make sure to use the 
+pre-commit hooks and if you skip a hook, describe why in the PR. 
+See the `{precommit}` [README.md](https://github.com/lorenzwalthert/precommit) 
+on how to install the pre-commit framework and the R package on your system and 
+then run
+```{r, eval = FALSE}
+precommit::use_precommit()
+```
+
+to make sure the hooks are activated in your local styler clone.

README.md

@@ -170,3 +170,18 @@ styler functionality is made available through other tools, most notably
     or the [pkgdown](https://r-lib.github.io/styler/) page contain
     information related to the initial development phase during Google
     Summer of Code 2017.
+
+## Contributing
+
+Please have a look at `CONTRIBUTING.md`, in particular, make sure to use
+the pre-commit hooks and if you skip a hook, describe why in the PR. See
+the `{precommit}`
+[README.md](https://github.com/lorenzwalthert/precommit) on how to
+install the pre-commit framework and the R package on your system and
+then run
+
+``` r
+precommit::use_precommit()
+```
+
+to make sure the hooks are activated in your local styler clone.

inst/WORDLIST

@@ -6,20 +6,25 @@ AppVeyor
 apriori
 arg
 AST
+backport
 benchmarking
 cancelling
 chnages
 CMD
 codecov
+compat
 config
 CONST
+coventions
 cran
 dec
+devtools
 dir
 dont
 dontrun
 dontshowdontrun
 donttest
+dplyr
 DSLs
 emacs
 emph
@@ -34,36 +39,53 @@ filetype
 forcond
 funct
 getOption
+github
+gitsum
+GSOC
 http
 https
 infinitively
+initializer
 innode
+interaces
 invasiveness
 io
 ixmypi
+Kirill
 knitr
+labelled
 levelName
 LF
 lifecycle
 lorenzwalthert
 macOS
+md
+Müller
+mutli
 NUM
+ourself
 packrat
 parsable
+parsesum
 pgkdown
 pkgdown
 pos
 pre
 precommit
+prefill
 prettycode
+PRs
 RcppExports
 rds
 readme
 README
 rebased
+reindent
 reindented
 reindention
+relevel
 renv
+repo
 reprex
 rlang
 rmarkdown
@@ -72,36 +94,46 @@ rmd
 Rmd
 rnw
 Rnw
+roxgen
 roxygen
 Roxygen
 rplumber
 rprofile
 Rprofile
 rstudio
+RStudio
+RStudio's
+saamwerk
 seealso
 StackOverflow
 STR
 styler
 stylerignore
 stylerignored
 stylers
+summarises
 tempfile
 testthat
 tibble
 tibbles
 tidyeval
+tidyr
 tidyverse
 Tidyverse
 ui
 uncached
 unexplainable
 unindent
+unindention
 unlink
 unlinkunindention
 unnest
 unstyled
 utf
 Visit'em
+Walthert
 xfun
+Xie
 xyzpackage
 yihui
+zzz