Skip to content
Merged
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: 2 additions & 0 deletions booknews.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## dev version

- 2025-02-25, add official rule on submitting one package at once only (`@maurolepore`, #876)
-
- 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)
Expand Down
1 change: 1 addition & 0 deletions softwarereview_author.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ This concise guide presents the software peer review process for you as a packag
- 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.
- Your package will continue to evolve after review, the chapter on *Package evolution* [provides guidance about the topic](#evolution).
- Please do not submit several packages at a time: we request you wait until a package has been approved before you submit another one.

## Preparing for Submission {#preparing-for-submission}

Expand Down
1 change: 1 addition & 0 deletions softwarereview_author.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Esta guía condensa el proceso de revisión por pares desde el punto de vista de
- En la fase de envío, todas las funciones principales deben ser lo suficientemente estables como para estar completamente documentadas y testeadas. El *README* tiene que dar una buena impresión de tu paquete.
- El archivo *README* debe esforzarse por explicar las funcionalidades y los objetivos de tu paquete asumiendo poco o ningún conocimiento del dominio. Además, debe aclarar todos los temas técnicos, incluidas las referencias a otros software.
- Tu paquete seguirá evolucionando después de la revisión, el capítulo sobre *Evolución de paquetes* [proporciona orientación sobre el tema](#evolution).
- Por favor, no envies varios paquetes a la vez: te rogamos que espere hasta que un paquete haya sido aprobado antes de enviar otro.

## Preparación para el envío {#preparing-for-submission}

Expand Down
1 change: 1 addition & 0 deletions softwarereview_author.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Este guia conciso apresenta o processo de revisão de software por pares, para v
- No estágio de envio da submissão, todas as principais funções devem ser estáveis o suficiente para serem totalmente documentadas e testadas; o README deve apresentar uma base segura para o pacote.
- Seu arquivo README deve assegurar-se em explicar a funcionalidade e os objetivos do seu pacote, presumindo que os leitores tenham pouco ou nenhum conhecimento do domínio. Todos os termos técnicos, inclusive as referências a outros softwares, devem ser esclarecidos.
- Seu pacote continuará a evoluir após a revisão. O capítulo sobre *Evolução do pacote* [fornece mais orientações sobre este tópico](#evolution).
- Não envie vários pacotes ao mesmo tempo: solicitamos que você espere até que um pacote seja aprovado antes de enviar outro.

## Preparando para Submissão {#preparing-for-submission}

Expand Down
Loading