Skip to content

link in reviewer guide to stats template for stats reviews #1012

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

Open
mpadge wants to merge 6 commits into
base: main
Choose a base branch
from
Open

link in reviewer guide to stats template for stats reviews #1012

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d81eb10
link in reviewer guide to stats template for stats reviews
mpadge May 25, 2026
06d5033
`babeldown::deepl_branch_update()`
maelle May 29, 2026
22d84fc
news item
maelle May 29, 2026
9c30047
Apply suggestions from code review
maelle Jun 1, 2026
cf0d6c2
Apply suggestion from @mpadge
mpadge Jun 1, 2026
4661028
Update softwarereview_reviewer.pt.Rmd
beatrizmilz Jun 1, 2026
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
1 change: 1 addition & 0 deletions booknews.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Dev version

- 2026-05-29, link in reviewer guide to stats template for stats reviews (#1012)
- 2026-04-10, two fixes to roxygen2 tags mentions (#1000, #1001, `@Pakillo`). Now 4 digits for PRs and issues!

## 1.0.0
Expand Down
4 changes: 3 additions & 1 deletion softwarereview_reviewer.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ All submissions trigger a detailed report on package structure and functionality

### General guidelines {#general-guidelines}

To review a package, please begin by copying our [review template](#reviewtemplate) and using it as a high-level checklist. In addition to checking off the minimum criteria, we ask that you provide general comments addressing the following:
To review a package, please begin by copying our [review template](#reviewtemplate), or the the [statistics review template](https://stats-devguide.ropensci.org/pkgreview.html#pkgrev-template) for statistical software.
These templates should be used as high-level checklists to guide initial review structure.
In addition to checking off the minimum criteria, we ask that you provide general comments addressing the following:

- Does the package comply with the [rOpenSci packaging guide](#building)?
- 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?
Expand Down
6 changes: 3 additions & 3 deletions softwarereview_reviewer.es.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ Todos los envíos generan un informe detallado sobre la estructura y funcionalid

### Directrices generales {#general-guidelines}

Para revisar un paquete, empieza por copiar nuestra [plantilla de revisión](#reviewtemplate) y utilízala como lista de verificación general. Además de marcar los criterios mínimos, te pedimos que hagas comentarios generales sobre lo siguiente:
Para revisar un paquete, empieza por copiar nuestro [plantilla de revisión](#reviewtemplate) o la plantilla [plantilla de examen estadístico](https://stats-devguide.ropensci.org/pkgreview.html#pkgrev-template) para software estadístico.
Estas plantillas deben utilizarse como listas de comprobación de alto nivel.
Copy link
Copy Markdown
Member Author

@mpadge mpadge Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Estas plantillas deben utilizarse como listas de comprobación de alto nivel.
Estas plantillas deben utilizarse como listas de comprobación de alto nivel para orientar la estructura de la revisión inicial.

@yabellini Can you please accept this suggestion if it looks okay to you? Thanks!

Además de marcar los criterios mínimos, te pedimos que aportes comentarios generales sobre lo siguiente:

- ¿Cumple el paquete con la [guía de empaquetado de rOpenSci](#building)?
- ¿Pueden mejorarse el estilo y los patrones del código? Por ejemplo, ¿es necesario dividir las funciones en funciones auxiliares más pequeñas y está claro el papel de cada función auxiliar?
Expand Down Expand Up @@ -115,5 +117,3 @@ Te animamos a que preguntes y opines sobre el proceso de revisión en https://gi
Las personas que enviaron el paquete a revisón deben responder en un plazo de 2 semanas con sus cambios en el paquete en respuesta a tu revisión. En esta fase, te pedimos que respondas si los cambios abordan suficientemente las cuestiones planteadas en tu revisión. Fomentamos el debate continuo entre quienes enviaron el paquete y quienes lo revisan, y también puedes pedir que quienes están a cargo de la edición aclaren cosas en el mismo hilo.

Utilizarás la [plantilla de aprobación](#approval2template).


7 changes: 3 additions & 4 deletions softwarereview_reviewer.pt.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Guia para revisores {#reviewerguide}

```{block, type="summaryblock"}
Expand Down Expand Up @@ -35,7 +34,9 @@ Todos os envios criam um relatório detalhado, gerado pelo nosso pacote [`pkgche

### Diretrizes gerais {#general-guidelines}

Para revisar um pacote, comece copiando o nosso [modelo de revisão](#reviewtemplate) e use ele como uma lista de verificações que precisam ser feitas. Além de marcar os critérios mínimos, pedimos que você forneça comentários gerais abordando o seguinte:
Para revisar um pacote, comece copiando nosso [modelo de revisão](#reviewtemplate) ou o [modelo de revisão para software estatístico](https://stats-devguide.ropensci.org/pkgreview.html#pkgrev-template).
Esses modelos devem ser usados como listas de verificação de alto nível.
Copy link
Copy Markdown
Contributor

@beatrizmilz beatrizmilz May 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do we mean by "high-level checklists"?

Copy link
Copy Markdown
Member

@maelle maelle Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mpadge can you please clarify?

Copy link
Copy Markdown
Member Author

@mpadge mpadge Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point - I've updated the English version from this:

These templates should be used as high-level checklists.

to this:

These templates should be used as high-level checklists to guide initial review structure.

Copy link
Copy Markdown
Member

@maelle maelle Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please update the translations @mpadge using either https://docs.ropensci.org/babeldown/reference/deepl_translate_clipboard.html or DeepL's web interface? Thank you!

Comment thread
beatrizmilz marked this conversation as resolved.
Outdated
Além de marcar os critérios mínimos na checklist, pedimos que você forneça comentários gerais abordando os seguintes pontos:

- O pacote está de acordo com os requisitos do [Guia de pacotes da rOpenSci](#building)?
- Há melhorias que poderiam ser feitas no estilo e nos padrões de código? Por exemplo, as funções precisam ser divididas em funções auxiliares menores e o papel de cada função auxiliar está claro?
Expand Down Expand Up @@ -115,5 +116,3 @@ Incentivamos você a fazer perguntas e fornecer feedbacks sobre o processo de re
Os(as) autores(as) devem responder dentro de 2 (duas) semanas com as alterações feitas no pacote em resposta à sua avaliação. Nesse estágio, pedimos que você avalie se as alterações são suficientes para resolver as questões levantadas em sua revisão. Incentivamos a discussão contínua entre autores(as) de pacotes e revisores(as), e você também pode pedir aos editores que esclareçam os problemas no tópico de revisão.

Você usará o [modelo de aprovação](#approval2template).