From 8e920640681e5d56132d9df9ea1ba76dbc54f885 Mon Sep 17 00:00:00 2001 From: mpadge Date: Tue, 11 Mar 2025 18:02:08 +0100 Subject: [PATCH 1/4] add link to pkgcheck env vignette to close #589 --- booknews.Rmd | 2 ++ softwarereview_author.Rmd | 3 ++- softwarereview_author.es.Rmd | 3 ++- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/booknews.Rmd b/booknews.Rmd index 60e74d032..16fe4c730 100644 --- a/booknews.Rmd +++ b/booknews.Rmd @@ -2,6 +2,8 @@ ## dev version +- 2025-03-11, add link to pkgcheck vignette on our testing environment (#589) + - 2025-03-11, mention the Air formatting tool wherever we mention the styler package (#875) - 2025-02-25, require the default git branch to not be called master (#863) diff --git a/softwarereview_author.Rmd b/softwarereview_author.Rmd index f7b932c2a..7b24a5adb 100644 --- a/softwarereview_author.Rmd +++ b/softwarereview_author.Rmd @@ -30,7 +30,8 @@ This concise guide presents the software peer review process for you as a packag - Read and follow [our packaging style guide](#building), [reviewer's guide](#preparereview) to ensure your package meets our style and quality criteria. - Feel free to ask any questions about the process, or your specific package, in our [Discussion Forum](https://discuss.ropensci.org). - All submissions are automatically checked by our [pkgcheck](https://docs.ropensci.org/pkgcheck/) system to ensure packages follow our guidelines. All authors are expected to have run [the main `pkgcheck` function](https://docs.ropensci.org/pkgcheck/reference/pkgcheck.html) locally to confirm that the package is ready to be submitted. Alternatively, an even easier way to ensure a package is ready for submission is to use [the `pkgcheck` GitHub Action](https://github.com/ropensci-review-tools/pkgcheck-action) to run `pkgcheck` as a GitHub Action, as described in [our blog post](https://ropensci.org/blog/2022/02/01/pkgcheck-action/). -- If your package requires unusual system dependencies (see [*Packaging Guide*](#pkgdependencies)) for our GitHub Action to pass, please submit a pull request adding them to [our base Dockerfile](https://github.com/ropensci-review-tools/pkgcheck/blob/main/Dockerfile). +- If your package requires unusual system dependencies (see [*Packaging Guide*](#pkgdependencies)) for our GitHub Action to pass, please submit a pull request adding them to [our base Dockerfile](https://github.com/ropensci-review-tools/pkgcheck/blob/main/Dockerfile). + See [this `pkgcheck` vignette](https://docs.ropensci.org/pkgcheck/articles/environment.html) for details of our checking environment, and how to modify it to help your package pass checks. - If there are any aspects of `pkgcheck` which your package is unable to pass, please explain reasons in your submission template. - If you feel your package is in scope for the [Journal of Open-Source Software](https://joss.theoj.org/) (JOSS), do not submit it to JOSS consideration until after the rOpenSci review process is over: if your package is deemed in scope by JOSS editors, only the accompanying short paper would be reviewed, (not the software that will have been extended reviewed by rOpenSci by that time). Not all rOpenSci packages will meet the criteria for JOSS. diff --git a/softwarereview_author.es.Rmd b/softwarereview_author.es.Rmd index 3f3b7932e..a8a1e09c0 100644 --- a/softwarereview_author.es.Rmd +++ b/softwarereview_author.es.Rmd @@ -25,7 +25,8 @@ Esta guía condensa el proceso de revisión por pares desde el punto de vista de - Lee y sigue nuestra [guía de estilo para paquetes](#building) y nuestra [guía para la revisión](#preparereview) para asegurarte de que tu paquete cumple nuestros criterios de estilo y calidad. - No dudes en hacer cualquier pregunta sobre el proceso en general, o sobre tu paquete en particular en nuestro [foro de discusión](https://discuss.ropensci.org). - Todos los envíos son revisados automáticamente por nuestro [propio sistema](https://docs.ropensci.org/pkgcheck/) para garantizar que los paquetes sigan nuestras directrices. Se espera que hayas corrido [la función `pkgcheck`](https://docs.ropensci.org/pkgcheck/reference/pkgcheck.html) localmente para confirmar que el paquete está listo para ser enviado. Otra forma aún más fácil de asegurarse de que un paquete está listo para su envío es utilizar [la acción de GitHub `pkgcheck`](https://github.com/ropensci-review-tools/pkgcheck-action) para ejecutar `pkgcheck` como una Acción de GitHub, como se describe en [esta publicación en nuestro blog](https://ropensci.org/blog/2022/02/01/pkgcheck-action/). -- Si tu paquete requiere dependencias inusuales del sistema (ver [*Guía de Empaquetado*](#pkgdependencies) para que nuestra Acción de GitHub pase, por favor envíe un _pull request_ añadiéndolas a [nuestro _Dockerfile_ base](https://github.com/ropensci-review-tools/pkgcheck/blob/main/Dockerfile). +- Si tu paquete requiere dependencias inusuales del sistema (ver [*Guía de Empaquetado*](#pkgdependencies) para que nuestra Acción de GitHub pase, por favor envíe un _pull request_ añadiéndolas a [nuestro _Dockerfile_ base](https://github.com/ropensci-review-tools/pkgcheck/blob/main/Dockerfile). + Consulte [esta viñeta `pkgcheck`](https://docs.ropensci.org/pkgcheck/articles/environment.html) para obtener más información sobre nuestro entorno de comprobación y cómo modificarlo para que su paquete pase las comprobaciones. - Si hay algún test de `pkgcheck` que tu paquete no pueda aprobar, explica los motivos en la plantilla de envío. - Si crees que tu paquete es relevante para el [Journal of Open Source Software](https://joss.theoj.org/) (JOSS), no lo sometas a consideración de JOSS hasta que haya finalizado el proceso de revisión de rOpenSci: si el equipo de edición de JOSS considera que tu paquete está dentro de su ámbito de aplicación, sólo se revisará el breve artículo que lo acompaña (pero no el software que habrá sido revisado por rOpenSci en ese momento). No todos los paquetes de rOpenSci pueden aplicar a JOSS. From fc7d901f55db7dc2139f1d5073cfcac6a956b5ff Mon Sep 17 00:00:00 2001 From: mpadge Date: Thu, 3 Apr 2025 10:29:44 +0200 Subject: [PATCH 2/4] add br.pt translation for testenv update for #589 --- softwarereview_author.pt.Rmd | 2 ++ 1 file changed, 2 insertions(+) diff --git a/softwarereview_author.pt.Rmd b/softwarereview_author.pt.Rmd index 3320f3291..4747e19fa 100644 --- a/softwarereview_author.pt.Rmd +++ b/softwarereview_author.pt.Rmd @@ -49,8 +49,10 @@ Este guia conciso apresenta o processo de revisão de software por pares, para v - Todas as submissões são verificadas automaticamente pelo nosso [`pkgcheck`](https://docs.ropensci.org/pkgcheck/) para garantir que os pacotes seguem nossas diretrizes. Espera-se que todos os autores tenham executado a [principal função do `pkgcheck`](https://docs.ropensci.org/pkgcheck/reference/pkgcheck.html) localmente para confirmar que o pacote está pronto para ser submetido. Como alternativa, uma maneira ainda mais fácil de garantir que um pacote está pronto para ser submetido é usando [a função `pkgcheck` do GitHub Action](https://github.com/ropensci-review-tools/pkgcheck-action), conforme descrito em [nossa postagem no blog](https://ropensci.org/blog/2022/02/01/pkgcheck-action/). - Se o seu pacote exigir dependências de sistema incomuns (consulte [*Guia de pacotes*](#pkgdependencies)) para que a _GitHub Action_ seja aprovada, envie um _pull request_ adicionando-as ao [nosso arquivo Dockerfile](https://github.com/ropensci-review-tools/pkgcheck/blob/main/Dockerfile). + Consulte [esta vinheta `pkgcheck`](https://docs.ropensci.org/pkgcheck/articles/environment.html) para obter detalhes sobre nosso ambiente de verificação e como modificá-lo para ajudar seu pacote a passar nas verificações. - Se houver algum aspecto do `pkgcheck` no qual seu pacote não possa ser aprovado, explique os motivos no seu modelo de submissão. + ### Manuscrito de acompanhamento (opcional) Se você pretende enviar um manuscrito de acompanhamento para seu pacote, a rOpenSci tem uma parceria de colaboração com o [Journal of Open-Source Software] (https://joss.theoj.org/) e o [Methods in Ecology and Evolution] (https://besjournals.onlinelibrary.wiley.com/journal/2041210X): From 30f4c94ed7392366441410ef30c3eccfd7b97591 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Thu, 10 Apr 2025 10:15:29 +0200 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Francesca Palmeira --- softwarereview_author.pt.Rmd | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/softwarereview_author.pt.Rmd b/softwarereview_author.pt.Rmd index 4747e19fa..87256ccd4 100644 --- a/softwarereview_author.pt.Rmd +++ b/softwarereview_author.pt.Rmd @@ -47,15 +47,15 @@ Este guia conciso apresenta o processo de revisão de software por pares, para v ### Verificações automáticas -- Todas as submissões são verificadas automaticamente pelo nosso [`pkgcheck`](https://docs.ropensci.org/pkgcheck/) para garantir que os pacotes seguem nossas diretrizes. Espera-se que todos os autores tenham executado a [principal função do `pkgcheck`](https://docs.ropensci.org/pkgcheck/reference/pkgcheck.html) localmente para confirmar que o pacote está pronto para ser submetido. Como alternativa, uma maneira ainda mais fácil de garantir que um pacote está pronto para ser submetido é usando [a função `pkgcheck` do GitHub Action](https://github.com/ropensci-review-tools/pkgcheck-action), conforme descrito em [nossa postagem no blog](https://ropensci.org/blog/2022/02/01/pkgcheck-action/). -- Se o seu pacote exigir dependências de sistema incomuns (consulte [*Guia de pacotes*](#pkgdependencies)) para que a _GitHub Action_ seja aprovada, envie um _pull request_ adicionando-as ao [nosso arquivo Dockerfile](https://github.com/ropensci-review-tools/pkgcheck/blob/main/Dockerfile). - Consulte [esta vinheta `pkgcheck`](https://docs.ropensci.org/pkgcheck/articles/environment.html) para obter detalhes sobre nosso ambiente de verificação e como modificá-lo para ajudar seu pacote a passar nas verificações. -- Se houver algum aspecto do `pkgcheck` no qual seu pacote não possa ser aprovado, explique os motivos no seu modelo de submissão. +- Todas as submissões são verificadas automaticamente pelo nosso [`pkgcheck`](https://docs.ropensci.org/pkgcheck/) para garantir que os pacotes sigam as nossas diretrizes. Espera-se que todas as pessoas autoras tenham executado a [principal função do `pkgcheck`](https://docs.ropensci.org/pkgcheck/reference/pkgcheck.html) localmente para confirmar que o pacote está pronto para ser submetido. Como alternativa, uma maneira ainda mais fácil de garantir que um pacote está pronto para ser submetido é usando [a função `pkgcheck` do GitHub Action](https://github.com/ropensci-review-tools/pkgcheck-action), conforme descrito em [nossa postagem no blog](https://ropensci.org/blog/2022/02/01/pkgcheck-action/). +- Se o seu pacote exigir dependências incomuns de sistema (consulte [*Guia de pacotes*](#pkgdependencies)) para que a _GitHub Action_ seja aprovada, envie um _pull request_ adicionando-as ao [nosso arquivo Dockerfile](https://github.com/ropensci-review-tools/pkgcheck/blob/main/Dockerfile). + Consulte [esta vinheta `pkgcheck`](https://docs.ropensci.org/pkgcheck/articles/environment.html) para obter detalhes sobre o nosso ambiente de verificação e como modificá-lo para ajudar o seu pacote a passar nas verificações. +- Se houver algum aspecto do `pkgcheck` no qual seu o pacote não possa ser aprovado, explique os motivos no seu modelo de submissão. ### Manuscrito de acompanhamento (opcional) -Se você pretende enviar um manuscrito de acompanhamento para seu pacote, a rOpenSci tem uma parceria de colaboração com o [Journal of Open-Source Software] (https://joss.theoj.org/) e o [Methods in Ecology and Evolution] (https://besjournals.onlinelibrary.wiley.com/journal/2041210X): +Se você pretende enviar um manuscrito de acompanhamento para seu o pacote, a rOpenSci tem uma parceria de colaboração com os periódicos [Journal of Open-Source Software] (https://joss.theoj.org/) e [Methods in Ecology and Evolution] (https://besjournals.onlinelibrary.wiley.com/journal/2041210X): - Para enviar um pacote ao Journal of Open-Source Software (JOSS), não o envie para consideração do JOSS até que o processo de revisão do rOpenSci tenha terminado: se o seu pacote for considerado dentro do escopo pelos editores do JOSS, apenas o artigo curto que o acompanha será revisado (não o software que terá sido revisado extensivamente pelo rOpenSci até aquele momento). Nem todos os pacotes da rOpenSci atenderão aos critérios do JOSS. - Para uma submissão ao Methods in Ecology and Evolution (MEE), envie-a ao MEE somente depois que as revisoras e revisores da rOpenSci tiverem enviado suas revisões, antes ou depois de o pacote ter sido aceito. A colaboração de revisão com a MEE foi apresentada em uma [postagem de blog](https://ropensci.org/blog/2017/11/29/review-collaboration-mee/). O tipo de artigo relevante para a MEE é [*Applications*](https://besjournals.onlinelibrary.wiley.com/hub/journal/2041210X/features/applicationpapers) para obter mais detalhes. From 5326b690b876991454a1bf78943ba1624aa9d458 Mon Sep 17 00:00:00 2001 From: Yanina Bellini Saibene Date: Thu, 10 Apr 2025 08:56:26 -0300 Subject: [PATCH 4/4] Apply suggestions from code review --- softwarereview_author.es.Rmd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/softwarereview_author.es.Rmd b/softwarereview_author.es.Rmd index 09f74cc3f..0eb8811b2 100644 --- a/softwarereview_author.es.Rmd +++ b/softwarereview_author.es.Rmd @@ -43,8 +43,8 @@ Esta guía condensa el proceso de revisión por pares desde el punto de vista de ### Controles automáticos - Todos los envíos son revisados automáticamente por nuestro [propio sistema](https://docs.ropensci.org/pkgcheck/) para garantizar que los paquetes sigan nuestras directrices. Se espera que hayas corrido [la función `pkgcheck`](https://docs.ropensci.org/pkgcheck/reference/pkgcheck.html) localmente para confirmar que el paquete está listo para ser enviado. Otra forma aún más fácil de asegurarse de que un paquete está listo para su envío es utilizar [la acción de GitHub `pkgcheck`](https://github.com/ropensci-review-tools/pkgcheck-action) para ejecutar `pkgcheck` como una Acción de GitHub, como se describe en [esta publicación en nuestro blog](https://ropensci.org/blog/2022/02/01/pkgcheck-action/). -- Si tu paquete requiere dependencias inusuales del sistema (ver [*Guía de Empaquetado*](#pkgdependencies) para que nuestra Acción de GitHub pase, por favor envíe un _pull request_ añadiéndolas a [nuestro _Dockerfile_ base](https://github.com/ropensci-review-tools/pkgcheck/blob/main/Dockerfile). - Consulte [esta viñeta `pkgcheck`](https://docs.ropensci.org/pkgcheck/articles/environment.html) para obtener más información sobre nuestro entorno de comprobación y cómo modificarlo para que su paquete pase las comprobaciones. +- Si tu paquete requiere dependencias inusuales del sistema (ver [*Guía de Empaquetado*](#pkgdependencies) para que nuestra Acción de GitHub pase, por favor envía un _pull request_ añadiéndolas a [nuestro _Dockerfile_ base](https://github.com/ropensci-review-tools/pkgcheck/blob/main/Dockerfile). + Consulta [esta viñeta `pkgcheck`](https://docs.ropensci.org/pkgcheck/articles/environment.html) para obtener más información sobre nuestro entorno de comprobación y cómo modificarlo para que tu paquete pase las verificaciones. - Si hay algún test de `pkgcheck` que tu paquete no pueda aprobar, explica los motivos en la plantilla de envío. ### Artículo complementario (opcional)