update contributing guidelines; closes #366

maintenance_collaboration.Rmd

@@ -31,24 +31,25 @@ And delete the package current code of conduct if there was one.
 
 You can use issue, pull request and contributing guidelines.
 Having a contributing file as `.github/CONTRIBUTING.md` or `docs/CONTRIBUTING.md` is compulsory.
+An easy way to insert a template for a contributing guide is the [`use_tidy_contributing()` function from the `usethis` package](https://usethis.r-lib.org/reference/tidyverse.html), which inserts [this template](https://github.com/r-lib/usethis/blob/main/inst/templates/tidy-contributing.md) as `.github/CONTRIBUTING.md`.
+A more extensive example is [this template by Peter Desmet](https://gist.github.com/peterdesmet/e90a1b0dc17af6c12daf6e8b2f044e7c), or the comprehensive [GitHub wiki pages for the mlr3 package](https://github.com/mlr-org/mlr3/wiki).
 
-Example of useful content:
+Adding a personal touch to your contributing guide tends to make it look less generic and more sincere. Personal preferences in a contributing guide include:
 
 * Style preferences? You might however prefer to make style a configuration (of [lintr](https://github.com/jimhester/lintr), [styler](https://styler.r-lib.org/)) or to [fix code style yourself](https://github.com/rstudio/blogdown/pull/432#pullrequestreview-368391904) especially if you don't use a popular code style like the [tidyverse coding style](https://style.tidyverse.org/).
 
 * Infrastructure like roxygen2?
 
-* Process preferences? Issue before a PR?
+* Workflow preferences? Issue before a PR?
 
-* Scope? E.g. in skimr.
+* A scope statement, like [in the skimr package](https://github.com/ropensci/skimr/blob/main/.github/CONTRIBUTING.md#understanding-the-scope-of-skimr)?
 
-* Sandbox account creation? Mocking in tests? Use links to external docs.
+* Sandbox account creation? Mocking in tests? Linking to external docs?
 
-Example: [contributing guide template by Peter Desmet](https://gist.github.com/peterdesmet/e90a1b0dc17af6c12daf6e8b2f044e7c).
-
-Adding a personal touch to your contributing guide might make it look less generic and therefore more sincere.
-
-CONTRIBUTING.md can also contain some details about how you acknowledge contributions (see [this section](#attributions)) and the roadmap of your package (cf [this example](https://github.com/ecohealthalliance/fasterize/blob/master/CONTRIBUTING.md)).
+rOpenSci further encourages contributing guides to include a lifecycle statement clarifying visions and expectations for the future development of your package, like [in this example](https://github.com/ecohealthalliance/fasterize/blob/master/CONTRIBUTING.md#roadmap).
+Statistical packages are required to have a lifecycle statement, as specified in [*General Statistical Stanards* G1.2](https://stats-devguide.ropensci.org/standards.html#documentation).
+That links provides a template for a simple lifecycle statement.
+CONTRIBUTING.md files can also describe how you acknowledge contributions (see [this section](#attributions)).
 
 We encourage you to direct feedback that is not a bug report or a feature request to [rOpenSci forum](https://discuss.ropensci.org/), after making sure you'd see such questions on the forum. Users can use the forum to ask questions about use and report their use cases, and you can subscribe to individual categories and tags to receive notifications about your package.  Feel free to mention this in the docs of your package and/or the contributing guidelines/issue template.  Please direct your users to tag posts with the package name.
 

pkg_building.Rmd

@@ -462,6 +462,8 @@ If you intend your package to be submitted to, or if your package is on, Biocond
 
 * Before submitting a package use the [**goodpractice**](https://github.com/MangoTheCat/goodpractice) package (`goodpractice::gp()`) as a guide to improve your package, since most exceptions to it will need to be justified. E.g. the use of `foo` might be generally bad and therefore flagged by `goodpractice` but you had a good reason to use it in your package.
 
+- Read, incorporate, and act on advice from the [*Collaboration Guide* chapter](#collaboration).
+
 ### Learning about package development
 
 #### Books