Skip to content

Commit a124a9a

Browse files
Moohanmaelle
authored andcommitted
Update softwarereview_reviewer.Rmd
1 parent 55ed488 commit a124a9a

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

softwarereview_reviewer.Rmd

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ aliases:
66
# Guide for Reviewers {#reviewerguide}
77

88
```{block, type="summaryblock"}
9-
Thanks for accepting to review a package for rOpenSci! This chapter consists of our guidelines to [prepare](#preparereview), [submit](#submitreview) and [follow up](#followupreviewer) on your review.
9+
Thanks for agreeing to review a package for rOpenSci! This chapter consists of our guidelines to [prepare](#preparereview), [submit](#submitreview) and [follow up](#followupreviewer) on your review.
1010
11-
You might contact the editor in charge of the submission for any question you might have about the process or your review.
11+
You might contact the editor in charge of the submission for any questions you might have about the process or your review.
1212
1313
Please strive to complete your review within 3 weeks of accepting a review request. We will aim to remind reviewers of upcoming and past due dates. Editors may assign
1414
additional or alternate reviewers if a review is excessively late.
1515
1616
**rOpenSci's community is our best asset.
1717
We aim for reviews to be open, non-adversarial, and focused on improving software quality.
1818
Be respectful and kind!
19-
See our reviewers guide and [code of conduct](https://ropensci.org/code-of-conduct/) for more.**
19+
See our reviewers' guide and [code of conduct](https://ropensci.org/code-of-conduct/) for more.**
2020
2121
_If you use our standards/checklists etc. when reviewing software elsewhere, do tell the recipients (e.g. journal editors, students, internal code review) that they came from rOpenSci, and tell us in [our public forum](https://discuss.ropensci.org/c/usecases), or [privately by email](https://ropensci.org/contact/)._
2222
```
@@ -29,7 +29,7 @@ Please fill our [volunteering form](https://ropensci.org/software-reviewer).
2929

3030
If you see a current submission that is particularly relevant to your interests please email `info@ropensci.org`, including the name of the package, the URL to the submission issue and the name of the assigned editor.
3131
However, keep in mind that reviewer invitations are kept at the editor's discretion, and the editor might well have already emailed people.
32-
Please do not volunteer for all issues, and do not volunteer via GitHub interface.
32+
Please do not volunteer for all issues, and do not volunteer via the GitHub interface.
3333

3434
For other ways to contribute, refer to [rOpenSci contributing guide](https://contributing.ropensci.org/).
3535

@@ -45,7 +45,7 @@ To review a package, please begin by copying our [review template](#reviewtempla
4545
- Does the package comply with the [rOpenSci packaging guide](#building)?
4646
- Are there improvements that could be made to the code style and to code patterns? For instance, do functions need to be broken down into smaller helper functions and is the role of each helper function clear?
4747
- Is there code duplication in the package that should be reduced?
48-
- Are there functions in base R or lightweight dependency that provide the same interface as some helper functions in the package?
48+
- Are there functions in base R or lightweight dependencies that provide the same interface as some helper functions in the package?
4949
- Are there user interface improvements that could be made?
5050
- Are there performance improvements that could be made?
5151
- Is the documentation (installation instructions/vignettes/examples/demos) clear and sufficient? Does it use the principle of *multiple points of entry* i.e. takes into account the fact that any piece of documentation may be the first encounter the user has with the package and/or the tool/data it wraps?
@@ -55,21 +55,21 @@ To review a package, please begin by copying our [review template](#reviewtempla
5555

5656
Please be respectful and kind to the authors in your reviews. Our [code of conduct](#code-of-conduct) is mandatory for everyone involved in our review process. We expect you to submit your review within 3 weeks, depending on the deadline set by the editor. Please contact the editor directly or in the submission thread to inform them about possible delays.
5757

58-
We encourage you to use automated tools to facilitate your reviewing. These include:
58+
We encourage you to use automated tools to facilitate your review. These include:
5959

6060
- Checking the initial package report generated by our `@ropensci-review-bot`.
6161
- Checking the package's logs on its continuous integration services (GitHub Actions, Codecov, etc.)
6262
- Running `devtools::check()` and `devtools::test()` on the package to find any errors that may be missed on the author's system.
6363
- Seeing whether tests' skipping is justified (e.g. `skip_on_cran()` tests that do real API requests vs. skipping all tests on one operating system).
64-
- If the package is not submitted via the default/main branch, remember to switch to the submitted review branch before starting your review. In this case, you will also have to search the package locally, as GitHub search is limited to the default branch. Further, documentation hosted on a `pkgdown` website is not necessarily up-to-date, and we recommend to inspect the package's documentation locally by running `pkgdown::build_site()`.
64+
- If the package is not submitted via the default/main branch, remember to switch to the submitted review branch before starting your review. In this case, you will also have to search the package locally, as GitHub search is limited to the default branch. Further, documentation hosted on a `pkgdown` website is not necessarily up-to-date, and we recommend inspecting the package's documentation locally by running `pkgdown::build_site()`.
6565

6666
Reviewers may also re-generate package check results from `@ropensci-review-bot` at any time by issuing the single comment in a review issue: `@ropensci-review-bot check package`.
6767

6868
Some items in our checklist were inspired by the [Mozilla code review guide](https://mozillascience.github.io/codeReview/review.html).
6969

7070
### Off-thread interactions {#off-thread-interactions}
7171

72-
If you interact with the package authors and talked about the review outside a review thread (in chats, DMs, in-person, issues in the project repository), please make sure that your review captures and/or links to elements from these conversations that are relevant to the process.
72+
If you interact with the package authors and talk about the review outside a review thread (in chats, DMs, in-person, issues in the project repository), please make sure that your review captures and/or links to elements from these conversations that are relevant to the process.
7373

7474
### Experience from past reviewers {#experience-from-past-reviewers}
7575

@@ -83,9 +83,9 @@ First-time reviewers may find it helpful to read (about) some previous reviews.
8383

8484
- `rusda` [review](https://github.com/ropensci/software-review/issues/18#issuecomment-120445737) (from before we had a review template)
8585

86-
You can read blog posts written by reviewers about their experiences [via this link](https://ropensci.org/tags/reviewer/). In particular, in [this blog post by Mara Averick](https://ropensci.org/blog/2017/08/22/first-package-review/) read about the "naive user" role a reviewer can take to provide useful feedback even without being experts of the package's topic or implementation, by asking themselves *"What did I think this thing would do? Does it do it? What are things that scare me off?"*. In [another blog post](https://ropensci.org/blog/2017/09/08/first-review-experiences/) Verena Haunschmid explains how she alternated between using the package and checking its code.
86+
You can read blog posts written by reviewers about their experiences [via this link](https://ropensci.org/tags/reviewer/). In particular, in [this blog post by Mara Averick](https://ropensci.org/blog/2017/08/22/first-package-review/) read about the "naive user" role a reviewer can take to provide useful feedback even without being an expert in the package's topic or implementation, by asking themselves *"What did I think this thing would do? Does it do it? What are the things that scare me off?"*. In [another blog post](https://ropensci.org/blog/2017/09/08/first-review-experiences/) Verena Haunschmid explains how she alternated between using the package and checking its code.
8787

88-
As both a former reviewer and package author, and now editor, [Adam Sparks](https://adamhsparks.netlify.app/) wrote "\[write\] a good critique of the package structure and best coding practices. If you know how to do something better, tell me. It's easy to miss documentation opportunities as a developer, as a reviewer, you have a different view. You're a user that can give feedback. What's not clear in the package? How can it be made more clear? If you're using it for the first time, is it easy? Do you know another R package that maybe I should be using? Or is there one I'm using that perhaps I shouldn't be? If you can contribute to the package, offer."
88+
As both a former reviewer and package author, and now editor, [Adam Sparks](https://adamhsparks.netlify.app/) wrote "\[write\] a good critique of the package structure and best coding practices. If you know how to do something better, tell me. It's easy to miss documentation opportunities as a developer, but as a reviewer, you have a different view. You're a user that can give feedback. What's not clear in the package? How can it be made more clear? If you're using it for the first time, is it easy? Do you know another R package that maybe I should be using? Or is there one I'm using that perhaps I shouldn't be? If you can contribute to the package, offer."
8989

9090
### Helper package for reviewers {#helper-package-for-reviewers}
9191

0 commit comments

Comments
 (0)