Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

review examples #365

Merged
merged 2 commits into from
Jan 10, 2022
Merged

review examples #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1042310
review examples
maelle Nov 30, 2021
7aa29e5
Merge branch 'dev' into review-examples
maelle Nov 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions appendix.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@

## dev

* 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).
Expand Down
12 changes: 12 additions & 0 deletions softwarereview_editor.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,18 @@ Thank authors for their submission, explain the reasons for the decision, and di
[Examples of out-of-scope submissions and responses](https://github.com/ropensci/software-review/issues?q=is%3Aissue+is%3Aclosed+label%3Aout-of-scope).



## Answering reviewers' questions {#reviewersupport}

Reviewers might ask for feedback on e.g. the tone of their review.
Beside pointing them at general guidance in this guide, asking editors / opening an issue when such guidance is lacking,
here are some review examples that might be useful.

* tough-but-constructive example: the part of this review suggesting a re-write of the vignette: [ropensci/software-review#191 (comment)](https://github.com/ropensci/software-review/issues/191#issuecomment-368254623).
* [the `slopes` package](https://github.com/ropensci/software-review/issues/420), which ended up being fundamentally redesigned in response to the reviews. All reviews/reviewers were at all times entirely constructive, which seems to have played a major role in motivating the authors to embark on such a major overhaul. Comments such as, _"this package does not ..."_ or _"has not ..."_ were invariably followed by constructive suggestions for what could be done (there are, for example, [several in one of the first reviews](https://github.com/ropensci/software-review/issues/420#issuecomment-858231647)).
* tic reviews politely expressed reservations: https://github.com/ropensci/software-review/issues/305#issuecomment-504762517 and https://github.com/ropensci/software-review/issues/305#issuecomment-508271766
* bowerbird useful ["pre-review"](https://github.com/ropensci/software-review/issues/139#issuecomment-322713737) that resulted in a package split before the actual reviews.

## Managing a dev guide release {#bookrelease}

If you are in charge of managing a release of the very book you are reading, use [the book release guidance](#bookreleaseissue) as an issue template to be posted [in the dev guide issue tracker](https://github.com/ropensci/dev_guide/issues), and do not hesitate to ask questions to other editors.
Expand Down