Merge pull request #367 from ropensci/dev

Dev for comparison

.github/workflows/pr.yml

@@ -4,12 +4,12 @@ name: PR-workflow
 
 jobs:
   bookdown:
-    name: Render Book
-    runs-on: macOS-latest
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
       NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+    name: Render Book
+    runs-on: macOS-latest
     if: github.repository == 'ropensci/dev_guide'
     steps:
       - name: Is this a fork

.zenodo.json

@@ -66,7 +66,8 @@
         },
         {
             "name": "Riederer, Emily",
-            "affiliation": "Capital One"
+            "affiliation": "Capital One",
+            "orcid": "0000-0002-1788-7934"
         },
         {
             "name": "Sparks, Adam",

DESCRIPTION

@@ -1,8 +1,8 @@
-Package: placeholder
+Package: rOpenSci_dev_guide
 Type: Website
 Title: rOpenSci Packages: Development, Maintenance, and Peer Review
 Description: rOpenSci Packages: Development, Maintenance, and Peer Review
-Version: 0.0.1
+Version: 0.8.0
 Imports:
     airtabler,
     htmltools,
@@ -21,3 +21,4 @@ Remotes:
     rstudio/bookdown,
     r-lib/downlit,
     r-lib/rlang
+URL: https://github.com/ropensci/dev_guide

appendix.Rmd

@@ -2,13 +2,75 @@
 
 # NEWS {#booknews}
 
+## 0.8.0
+
+- 2022-06-03, Remove former references to now-archived "rodev" package
+
+- 2022-05-30, Advise that reviewers can also directly call `@ropensci-review-bot check package`
+
+- 2022-05-27, Add Mark Padgham to list of authors
+
+- 2022-05-27, Add `devguider::prerelease_checklist` item to pre-release template (#463)
+
+- 2022-05-13, Align version number in DESCRIPTION file with actual version (#443)
+
+- 2022-05-13, Update guidelines for CONTRIBUTING.md (#366, #462)
+
+- 2022-05-09, Add section on authorship of included code, thanks to `@KlausVigo` (#388).
+
+- 2022-05-09, Remove mention of 'rev' role requiring R v3.5
+
+- 2022-05-05, Move all scripts from local `inst` directory to `ropensci-org/devguider` pkg.
+
+- 2022-05-03, Update package archiving guidance to reduce README to minimal form.
+
+- 2022-04-29, Advise that authors can directly call `@ropensci-review-bot check package`.
+
+- 2022-04-29, Describe `pkgcheck-action` in CI section.
+
+- 2022-04-29, Update scope in policies section to include statistical software.
+
+- 2022-04-29, Add `prelease.R` script to open pre-release GitHub issue & ref in appendix.
+
+- 2022-04-26, Add GitHub 2FA recommendation to package security.
+
+- 2022-03-29, Remove references to Stef Butland, former community manager.
+
+- 2022-03-28, Add comments on submission planning about time commitment.
+
+- 2022-03-24, Remove approval comment template (coz it's automatically generated by the bot now).
+
+- 2022-03-21, rephrase CITATION guidance to make it less strict. Also mentions CITATION.cff and the cffr package.
+
+- 2022-03-08, add links to blogs related to package development (#389).
+
+- 2022-02-17, update redirect instructions (`@peterdesmet`, #387).
+
+- 2022-02-14, link to Michael Lynch's post Why Good Developers Write Bad Unit Tests.
+
+- 2022-02-14, mention more packages for testing like dittodb, vcr, httptest, httptest2, webfakes.
+
+- 2022-01-10, make review templates R Markdown files (`@Bisaloo`, #340).
+
+- 2022-01-14, update guidance on CI services (#377)
+
+- 2022-01-11, update guidance around branches, with resources suggested by `@ha0ye` and `@statnmap`.
+
+- 2022-01-10, divide author's guide into sub-sections, and add extra info including `pkgcheck`.
+
+* 2021-11-30, adds links to examples of reviews, especially tough but constructive ones (with help from `@noamross`, `@mpadge`, #363).
+
+* 2021-11-19, add recommended spatial packages to scaffolding section (software-review-meta#47)
+
+* 2021-11-18, update advice on grouping functions for pkgdown output (#361)
+
 ## 0.7.0
 
 * 2021-11-04, add mentions of stat software review to software review intro and to the first book page (#342).
 
 * 2021-11-04, mention pkgcheck in the author guide (@mpadge, #343).
 
-* 2021-11-04, add editors' responsabilities including  Editor etiquette for commenting on packages on which you aren't handling/reviewing (@jhollist, #354). 
+* 2021-11-04, add editors' responsibilities including  Editor etiquette for commenting on packages on which you aren't handling/reviewing (@jhollist, #354). 
 
 * 2021-11-04, give precise examples of tools for installation instructions (remotes, pak, R-universe).
 
@@ -291,34 +353,6 @@ Editors may make use of the e-mail template below in recruiting reviewers.
 
 ```
 
-# Approval comment template {#approvaltemplate}
-
-````markdown
-```{r, eval = !knitr::is_latex_output(), results="asis", echo=FALSE, comment = ""}
-withr::with_tempfile("tf", {
-download.file(
-    "https://raw.githubusercontent.com/ropensci/software-review/master/.buffy/templates/approved.md",
-    tf
-  )
-  lines <- readLines(tf)
-cat(lines[2:(length(lines) - 1)], sep = "\n")
-}
-)
-
-```
-````
-
-```{r, eval = knitr::is_latex_output(), echo=FALSE, comment = "", results='asis'}
-withr::with_tempfile("tf", {
-download.file(
-    "https://raw.githubusercontent.com/ropensci/software-review/master/.buffy/templates/approved.md",
-    tf
-  )
-  lines <- readLines(tf)
-cat(lines[2:(length(lines) - 1)], sep = "\n\n")
-}
-)
-```
 
 # Reviewer approval comment template {#approval2template}
 
@@ -343,6 +377,10 @@ cat(lines[2:(length(lines) - 1)], sep = "\n\n")
 
 # Book release guidance {#bookreleaseissue}
 
+Editors preparing for a release can run the `prelease.R` script in the `inst` directory of this repository to automatically open a GitHub issue with checkpoints for all current issues assigned to the upcoming release milestone, along with the following checklist. 
+Before running the script, please manually check the assignment of issues to the milestone.
+This should be run one month prior to planned release.
+
 
 ```markdown
 ```{r, eval = !knitr::is_latex_output(), child="templates/book-release.md"}
@@ -357,15 +395,12 @@ cat(lines[2:(length(lines) - 1)], sep = "\n\n")
 
 ## Non GitHub pages site (e.g. Netlify)
 
-Replace the content of the current website with
+Replace the content of the current website with a `index.html` and `404.html` files both containing:
 
 ```html
 <html>
 <head>
-<meta http-equiv="refresh" content="0;URL=https://docs.ropensci.org/<pkgname>/" />  
-<script language="javascript">
-  window.location.href = "https://docs.ropensci.org/<pkgname>"
-</script>
+<meta http-equiv="refresh" content="0;URL=https://docs.ropensci.org/<pkgname>/">  
 </head>
 </html>
 ```
@@ -374,7 +409,6 @@ Replace the content of the current website with
 
 You can setup the redirect from your main user gh-pages repository:
 
- - create a new repository (if you don't have one yet): `https://github.com/<username>/<username>.github.io`
- - In this repository create a directory `<pkgname>` containing the file `index.html` that redirects to the new location (see previous subsection)
- - Test that https://<username>.github.io/<pkgname>/index.html now redirects
- - Optional: you could even create a `404.html` file in your `<username>.github.io` repo to redirect arbitrary pages.
+ - create a new repository (if you don't have one yet): `https://github.com/<username>/<username>.github.io`.
+ - In this repository create a directory `<pkgname>` containing 2 files: a `index.html` and `404.html` file, which both redirect to the new location (see previous subsection).
+ - Test that `https://<username>.github.io/<pkgname>/index.html` now redirects.

index.Rmd

@@ -1,6 +1,6 @@
 --- 
 title: "rOpenSci Packages: Development, Maintenance, and Peer Review"
-author: "rOpenSci software review editorial team (current and alumni): Brooke Anderson, Scott Chamberlain, Laura DeCicco, Julia Gustavsen, Jeff Hollister, Anna Krystalli, Mauro Lepore, Lincoln Mullen, Karthik Ram, Emily Riederer, Noam Ross, Maëlle Salmon, Adam Sparks, Melina Vidoni"
+author: "rOpenSci software review editorial team (current and alumni): Brooke Anderson, Scott Chamberlain, Laura DeCicco, Julia Gustavsen, Jeff Hollister, Anna Krystalli, Mauro Lepore, Lincoln Mullen, Mark Padgham, Karthik Ram, Emily Riederer, Noam Ross, Maëlle Salmon, Adam Sparks, Melina Vidoni"
 date: "`r Sys.Date()`"
 site: bookdown::bookdown_site
 documentclass: book
@@ -52,7 +52,7 @@ The [second section](#softwarereviewintro) is dedicated to rOpenSci's software p
 
 The [third and last section](#collaboration) features our best practice for nurturing your package once it has been onboarded: how to collaborate with other developers, how to document releases, how to promote your package and how to leverage GitHub as a development platform. The third section also features a [chapter for anyone wishing to start contributing to rOpenSci packages](#contributingguide).
 
-We hope that you'll find the guide useful and clear, and welcome your suggestions in the [issue tracker of the book](https://github.com/ropenscilabs/dev_guide/issues). Happy R packaging!
+We hope that you'll find the guide useful and clear, and welcome your suggestions in the [issue tracker of the book](https://github.com/ropensci/dev_guide/issues). Happy R packaging!
 
 The rOpenSci editorial team.
 
@@ -69,5 +69,7 @@ done <- file.remove("dev_citation_BibTeX.bib")
 
 _If you want to contribute to this book (suggestions, corrections) please refer to [the GitHub repository](https://github.com/ropensci/dev_guide) in particular [the contributing guidelines](https://github.com/ropensci/dev_guide#contributing). Thanks!_
 
-_We are thankful for all authors, reviewers and guest editors for helping us improve the system and this guide over the years. Thanks also to the following persons who made contributions to this guide and its previous incarnations: [Katrin Leinweber](https://github.com/katrinleinweber), [John Baumgartner](https://github.com/johnbaums), [François Michonneau](https://github.com/fmichonneau), [Christophe Dervieux](https://github.com/cderv), [Lorenzo Busetto](https://github.com/lbusett), [Ben Marwick](https://github.com/benmarwick), [Nicholas Horton](https://github.com/nicholasjhorton), [Chris Kennedy](https://github.com/ck37), [Mark Padgham](https://github.com/mpadge), [Jeroen Ooms](https://github.com/jeroen), [Sean Hughes](https://github.com/seaaan), [Jan Gorecki](https://github.com/jangorecki), [Joseph Stachelek](https://github.com/jsta), [Dean Attali](https://github.com/daattali), [Julia Gustavsen](https://github.com/jooolia), [Nicholas Tierney](https://github.com/njtierney), [Rich FitzJohn](https://github.com/richfitz), [Tiffany Timbers](https://github.com/ttimbers), [Hilmar Lapp](https://github.com/hlapp), [Miles McBain](https://github.com/milesmcbain), [Bryce Mecum](https://github.com/amoeba), [Jonathan Carroll](https://github.com/jonocarroll/), [Carl Boettiger](https://github.com/cboettig/), [Florian Privé](https://github.com/privefl), [Stefanie Butland](https://github.com/stefaniebutland), [Daniel Possenriede](https://github.com/dpprdan/), [Hadley Wickham](https://github.com/hadley/), [Hugo Gruson](https://github.com/bisaloo/), [Mauro Lepore](https://github.com/maurolepore/), [Matthew Fidler](https://github.com/mattfidler), [Luke McGuinness](https://github.com/mcguinlu), [Aaron Wolen](https://github.com/aaronwolen), [Indrajeet Patil](https://github.com/IndrajeetPatil), [Kevin Wright](https://github.com/kwstat), [Will Landau](https://github.com/wlandau), [Hugo Gruson](https://github.com/Bisaloo). Please tell us if we forgot to acknowledge your contribution!_
+_We are thankful for all authors, reviewers and guest editors for helping us improve the system and this guide over the years. Thanks also to the following persons who made contributions to this guide and its previous incarnations: [Katrin Leinweber](https://github.com/katrinleinweber), [John Baumgartner](https://github.com/johnbaums), [François Michonneau](https://github.com/fmichonneau), [Christophe Dervieux](https://github.com/cderv), [Lorenzo Busetto](https://github.com/lbusett), [Ben Marwick](https://github.com/benmarwick), [Nicholas Horton](https://github.com/nicholasjhorton), [Chris Kennedy](https://github.com/ck37), [Mark Padgham](https://github.com/mpadge), [Jeroen Ooms](https://github.com/jeroen), [Sean Hughes](https://github.com/seaaan), [Jan Gorecki](https://github.com/jangorecki), [Joseph Stachelek](https://github.com/jsta), [Dean Attali](https://github.com/daattali), [Julia Gustavsen](https://github.com/jooolia), [Nicholas Tierney](https://github.com/njtierney), [Rich FitzJohn](https://github.com/richfitz), [Tiffany Timbers](https://github.com/ttimbers), [Hilmar Lapp](https://github.com/hlapp), [Miles McBain](https://github.com/milesmcbain), [Bryce Mecum](https://github.com/amoeba), [Jonathan Carroll](https://github.com/jonocarroll/), [Carl Boettiger](https://github.com/cboettig/), [Florian Privé](https://github.com/privefl), [Stefanie Butland](https://github.com/stefaniebutland), [Daniel Possenriede](https://github.com/dpprdan/), [Hadley Wickham](https://github.com/hadley/), [Mauro Lepore](https://github.com/maurolepore/), [Matthew Fidler](https://github.com/mattfidler), [Luke McGuinness](https://github.com/mcguinlu), [Aaron Wolen](https://github.com/aaronwolen), [Indrajeet Patil](https://github.com/IndrajeetPatil), [Kevin Wright](https://github.com/kwstat), [Will Landau](https://github.com/wlandau), [Hugo Gruson](https://github.com/Bisaloo),
+[Hao Ye](https://github.com/ha0ye),
+[Sébastien Rochette](https://github.com/statnmap). Please tell us if we forgot to acknowledge your contribution!_
 

maintenance_changing_maintainers.Rmd

@@ -28,10 +28,10 @@ We have a call for contributors section in our newsletter that comes out every t
   It depends; here's what to do in different scenarios:
 
     - if the old maintainer can be contacted: reach out to them, and ask for help;
-    - rOpenSci slack: good for getting help on specific or general problems, the #general room is where many ask questions;
-    - rOpenSci discussion forum: this forum is a good option, feel free to ask any questions there;
-    - rOpenSci staff: feel free to get in touch with one of us via slack/email/pinging us on GitHub issues, we'll be happy to help;
-    - of course there's general R help too if that suits your needs: StackOverflow, Twitter #rstats, etc.
+    - rOpenSci slack: good for getting help on specific or general problems, see the #package-maintenance channel;
+    - [rOpenSci discussion forum](https://discuss.ropensci.org/c/package-development/29): this forum is a good option, feel free to ask any questions there;
+    - [rOpenSci staff](https://ropensci.org/about/#team): feel free to get in touch with one of us via email/pinging us on GitHub issues, we'll be happy to help;
+    - of course there's general R help too if that suits your needs: RStudio community forum, StackOverflow, Twitter #rstats, etc.
 
 * How much can/should you change in the package?
 
@@ -53,7 +53,7 @@ As an organization, rOpenSci is interested in making sure packages in our suite
   * Make contact and see what the situation is. They may say they’d like to step down as maintainer, in which case look for a new maintainer
 * Current maintainer is completely missing/not responding
   * If this happens we will try to contact the maintainer for up to one month. However, if updating the package is urgent, we may use our admin access to make changes on their behalf.
-* Put a call out in the “Call for Contributors” section of the rOpenSci newsletter for a new maintainer - get in touch with Scott for this or open an issue in the [newsletter repo](https://github.com/ropensci/biweekly/)
+* Put a call out in the “Call for Contributors” section of the rOpenSci newsletter for a new maintainer - open an issue in the [newsletter repo](https://github.com/ropensci/monthly/).
 
 
 [orphaned]: https://cran.r-project.org/src/contrib/Orphaned/README