Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
run: Rscript -e 'file.copy(from = "_book/rOpenSci-Packages--Development,-Maintenance,-and-Peer-Review.pdf", to = "_book/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/images")'

- name: Move Spanish files
run: Rscript -e 'file.copy(from = "_book/es/rOpenSci-Packages--Development,-Maintenance,-and-Peer-Review.pdf", to = "_book/es/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/es/images")'
run: Rscript -e 'file.copy(from = "_book/es/Paquetes-de-rOpenSci--Desarrollo,-mantenimiento-y-revisión-por-pares.pdf", to = "_book/es/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/es/images")'

- name: Move Portuguese files
run: Rscript -e 'file.copy(from = "_book/pt/Pacotes-rOpenSci--Desenvolvimento,-manutenção-e-revisão-por-pares.pdf", to = "_book/pt/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/pt/images")'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/scheduled-manual-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
run: Rscript -e 'file.copy(from = "_book/rOpenSci-Packages--Development,-Maintenance,-and-Peer-Review.pdf", to = "_book/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/images")'

- name: Move Spanish files
run: Rscript -e 'file.copy(from = "_book/es/rOpenSci-Packages--Development,-Maintenance,-and-Peer-Review.pdf", to = "_book/es/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/es/images")'
run: Rscript -e 'file.copy(from = "_book/es/Paquetes-de-rOpenSci--Desarrollo,-mantenimiento-y-revisión-por-pares.pdf", to = "_book/es/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/es/images")'

- name: Move Portuguese files
run: Rscript -e 'file.copy(from = "_book/pt/Pacotes-rOpenSci--Desenvolvimento,-manutenção-e-revisão-por-pares.pdf", to = "_book/pt/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/pt/images")'
Expand Down
6 changes: 4 additions & 2 deletions pkg_building.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ where issue\_id is the number of the issue in the software-review repository. Fo

- Consider using `usethis::use_readme_rmd()` to get a template for a `README.Rmd` file and to automatically set up a pre-commit hook to ensure that `README.md` is always newer than `README.Rmd`.

- Extensive examples should be kept for a vignette. If you want to make the vignettes more accessible before installing the package, we suggest [creating a website for your package](#website).
- Extensive examples should be kept for a vignette. If you want to make the vignettes more accessible before installing the package, we suggest [creating a website for your package](#website). All packages submitted for software review must have a website.

- Add a [code of conduct and contribution guidelines](#friendlyfiles).

Expand Down Expand Up @@ -271,7 +271,9 @@ Others have used the option to escape some URLs (change `<https://ropensci.org/>

## Documentation website {#website}

We recommend creating a documentation website for your package using [`pkgdown`](https://github.com/r-lib/pkgdown). The R packages book features a [chapter on pkgdown](https://r-pkgs.org/website.html), and of course `pkgdown` has [its own documentation website](https://pkgdown.r-lib.org/).
All packages submitted for software review must have a documentation website clearly linked in the source repository.
We recommend using [`pkgdown`](https://github.com/r-lib/pkgdown) to create your website.
The R packages book features a [chapter on pkgdown](https://r-pkgs.org/website.html), and of course `pkgdown` has [its own documentation website](https://pkgdown.r-lib.org/).

There are a few elements we'd like to underline here.

Expand Down
3 changes: 2 additions & 1 deletion pkg_building.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ La etiqueta indicará primero "en revisión" y luego "revisado" una vez que tu p
- Considera utilizar `usethis::use_readme_rmd()` para generar una plantilla para el archivo `README.Rmd` y para configurar automáticamente un chequeo que garantice que `README.md` sea siempre más reciente que `README.Rmd` antes de hacer un commit.

- Los ejemplos largos deben incluirse sólo en las viñetas.
Si quieres que las viñetas sean más accesibles antes de instalar el paquete, te sugerimos [crear un sitio web para tu paquete](#website).
Si quieres que las viñetas sean más accesibles antes de instalar el paquete, te sugerimos [crear un sitio web para tu paquete](#website). Todos los paquetes presentados para su revisión deben contar con un sitio web.

- Añade un [código de conducta y una guía de contribución](#friendlyfiles).

Expand Down Expand Up @@ -297,6 +297,7 @@ Además, no se podrá hacer click en los enlaces desde la documentación local.

## Sitio web de documentación {#website}

Todos los paquetes enviados para su revisión de software deben incluir un enlace claro a la página web de documentación en el repositorio de código fuente.
Te recomendamos que crees un sitio web con la documentación de tu paquete utilizando [`pkgdown`](https://github.com/r-lib/pkgdown).
Hay un [capítulo sobre pkgdown (en inglés)](https://r-pkgs.org/website.html) en libro "R packages", y, cómo no es de extrañar, el paquete `pkgdown` tiene [su propio sitio web de documentación](https://pkgdown.r-lib.org/).

Expand Down
3 changes: 2 additions & 1 deletion pkg_building.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ onde issue\_id é o número da *Issue* no repositório `software-review`. Por ex

- Considere o uso da função `usethis::use_readme_rmd()` para obter um modelo para o arquivo `README.Rmd` e para configurar automaticamente uma verificação para garantir que o arquivo `README.md` seja sempre mais recente que o `README.Rmd` antes de fazer um commit.

- Exemplos extensos devem ser mantidos em uma vinheta. Se você quiser tornar as vinhetas mais acessíveis antes de instalar o pacote, sugerimos [criar um site para seu pacote](#website).
- Exemplos extensos devem ser mantidos em uma vinheta. Se você quiser tornar as vinhetas mais acessíveis antes de instalar o pacote, sugerimos [criar um site para seu pacote](#website). Todos os pacotes enviados para revisão de software devem ter um site.

- Adicionar um [código de conduta e as diretrizes de contribuição](#friendlyfiles).

Expand Down Expand Up @@ -270,6 +270,7 @@ Outras pessoas já usaram a opção para escapar de alguns URLs (alterar `<https

## Site de documentação {#website}

Todos os pacotes enviados para revisão de software devem ter um site de documentação claramente indicado no repositório de código-fonte.
Recomendamos a criação de um site de documentação para seu pacote usando o pacote [`pkgdown`](https://github.com/r-lib/pkgdown). O livro *R packages* (em inglês) apresenta um [capítulo sobre pkgdown](https://r-pkgs.org/website.html) e também o `pkgdown` tem [seu próprio site de documentação](https://pkgdown.r-lib.org/).

Há alguns elementos que gostaríamos de destacar aqui.
Expand Down
3 changes: 2 additions & 1 deletion softwarereview_author.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ This concise guide presents the software peer review process for you as a packag

### Documentation

- For any submission or pre-submission inquiry the README of your package should provide enough information about your package (goals, usage, similar packages) for the editors to assess its scope without having to install the package. Even better, set up a pkgdown website for allowing more detailed assessment of functionality online.
- For any submission or pre-submission inquiry the README of your package should provide enough information about your package (goals, usage, similar packages) for the editors to assess its scope without having to install the package.
- At the submission stage, all major functions should be stable enough to be fully documented and tested; the README should make a strong case for the package.
- Your README file should strive to explain your package's functionality and aims, assuming readers have little to no domain knowledge. All technical tems, including references to other software, should be clarified.
- All packages require a website, with a URL specified in the "About" section of the GitHub repository. See the [Documentation website section](#website) for details.
- Your package will continue to evolve after review, the chapter on *Package evolution* [provides guidance about the topic](#evolution).

## Preparing for Submission {#preparing-for-submission}
Expand Down
2 changes: 1 addition & 1 deletion softwarereview_policies.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ general guidelines should be followed by packages where the challenges above ari
Lab](http://socialdatalab.net/ethics-resources)).

- Packages accessing personally identifiable information should take special
care to follow \[security best practices\]\[Package Development Security Best Practices\]
care to follow [security best practices](#package-development-security-best-practices)
(e.g., exclusive use of secure internet protocols, strong mechanisms for
storing credentials, etc.).

Expand Down
2 changes: 1 addition & 1 deletion softwarereview_policies.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Embora a melhor resposta às preocupações éticas seja específica para cada c

Observe que o consentimento não é concedido implicitamente apenas pelo fato de os dados estarem acessíveis. Dados acessíveis não são necessariamente públicos, já que diferentes pessoas e contextos têm diferentes expectativas normativas de privacidade (consulte o trabalho do [Social Data Lab](http://socialdatalab.net/ethics-resources)).

- Os pacotes que acessam informações pessoais identificáveis devem ter um cuidado especial para seguir as práticas recomendadas de segurança (por exemplo, uso exclusivo de protocolos de internet seguros, mecanismos fortes para armazenamento de credenciais, etc.)
- Os pacotes que acessam informações pessoais identificáveis devem ter um cuidado especial para seguir as [práticas recomendadas de segurança](#package-development-security-best-practices) (por exemplo, uso exclusivo de protocolos de internet seguros, mecanismos fortes para armazenamento de credenciais, etc.)

- Pacotes que acessam ou manipulam dados pessoais identificáveis ou dados sensíveis devem permitir, documentar e demonstrar fluxos de trabalho para desidentificação, armazenamento seguro e outras práticas recomendadas para minimizar o risco de danos.

Expand Down
2 changes: 1 addition & 1 deletion templates/request.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Hola, soy [EDITOR/A]. [COMENTARIO AMISTOSO]. Te escribo para preguntarte si te i

El paquete, [PAQUETE] de [AUTOR(ES)], realiza [FUNCIÓN]. Puedes encontrarlo en GitHub aquí: [ENLACE REPO]. Hacemos nuestro proceso de revisión abierta a través de GitHub, aquí: [ISSUE DE REVISIÓN]

Si aceptas, ten en cuenta que te pediremos completes las revisiones en tres semanas. (Hemos comprobado que lleva un tiempo similar revisar un paquete que un artículo académico).
Si aceptas, ten en cuenta que te pediremos que completes las revisiones en tres semanas. (Hemos comprobado que lleva un tiempo similar revisar un paquete que un artículo académico).

Nuestra [guía de revisión][guía de revisión] detalla lo que buscamos en la revisión de un paquete, e incluye enlaces a ejemplos de revisiones. Nuestras normas se detallan en nuestra [guía de empaquetado][guía de empaquetado] y proporcionamos una [plantilla][plantilla] para que la utilices en revisión. Por favor, asegúrate de que no tienes un [conflicto de intereses](https://devguide.ropensci.org/policies.html#coi) que te impida revisar este paquete. Si tienes alguna pregunta o comentario, no dudes en preguntarme.

Expand Down
Loading