From 4c9d1e99597982f9f4f8bd5ebd6f6d9b012ad525 Mon Sep 17 00:00:00 2001 From: Yanina Date: Wed, 13 Mar 2024 13:19:12 -0300 Subject: [PATCH 01/12] Add PT-BR automatic translation softwarereview_reviewer.pt.Rmd --- softwarereview_reviewer.pt.Rmd | 120 +++++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 softwarereview_reviewer.pt.Rmd diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd new file mode 100644 index 000000000..1dcddaaa8 --- /dev/null +++ b/softwarereview_reviewer.pt.Rmd @@ -0,0 +1,120 @@ +--- +aliases: reviewerguide.html +--- + +# Guia para revisores {#reviewerguide} + +```{block, type="summaryblock"} +Obrigado por você ter aceitado revisar um pacote para a rOpenSci! Este capítulo consiste em nossas diretrizes para [preparar](#preparereview), [enviar](#submitreview) e [acompanhar](#followupreviewer) a sua revisão. + +Você pode entrar em contato com o editor responsável pela submissão para esclarecer qualquer dúvida que tenha sobre o processo ou sobre a sua revisão. + +Esforce-se para concluir sua avaliação em até 3 semanas após a aceitação da solicitação de avaliação. Procuraremos lembrar os revisores das datas de vencimento futuras e passadas. Os editores podem designar +Os editores podem designar revisores adicionais ou alternativos se uma revisão estiver excessivamente atrasada. + +A comunidade do **rOpenSci é o nosso melhor patrimônio. +Nosso objetivo é que as revisões sejam abertas, não contraditórias e focadas na melhoria da qualidade do software. +Seja respeitoso e gentil! +Consulte nosso guia de revisores e o [código de conduta] (https://ropensci.org/code-of-conduct/) para obter mais informações.** Você pode encontrar mais informações em nosso guia de revisores. + +_Se você usar nossos padrões/listas de verificação etc. ao revisar um software em outro lugar, informe aos destinatários (por exemplo, editores de periódicos, estudantes, revisão interna de código) que eles vieram da rOpenSci e nos informe em [nosso fórum público] (https://discuss.ropensci.org/c/usecases) ou [em particular por e-mail] (https://ropensci.org/contact/). +``` + +## Como voluntário como revisor {#volunteering-as-a-reviewer} + +Obrigado pelo seu desejo de participar da revisão por pares do software rOpenSci como revisor! + +Por favor, preencha nosso [formulário de voluntariado](https://ropensci.org/software-reviewer). + +Se você vir um envio atual que seja particularmente relevante para seus interesses, envie um e-mail para `info@ropensci.org` incluindo o nome do pacote, o URL do problema do envio e o nome do editor designado. +No entanto, lembre-se de que os convites para revisores são mantidos a critério do editor, e é bem possível que o editor já tenha enviado um e-mail para as pessoas. +Não se voluntarie para todas as edições e não se voluntarie por meio da interface do GitHub. + +Para outras maneiras de contribuir, consulte [Guia de contribuição do rOpenSci](https://contributing.ropensci.org/). + +## Preparando sua revisão {#preparereview} + +As revisões devem ser baseadas na versão mais recente do GitHub no branch padrão, a menos que indicado de outra forma pelos autores do pacote. +Todos os envios acionam um relatório detalhado sobre a estrutura e a funcionalidade do pacote, gerado por [nosso `pkgcheck` pacote](https://docs.ropensci.org/pkgcheck/). Se o pacote tiver sido alterado substancialmente desde as últimas verificações, você poderá solicitar uma nova verificação com o comando `@ropensci-review-bot check package`. Observe que, ao instalar o pacote para revisá-lo, você deve se certificar de que tem todas as dependências disponíveis (por exemplo, execute `pak::pak()`). + +### Diretrizes gerais {#general-guidelines} + +Para revisar um pacote, comece copiando nosso [modelo de revisão](#reviewtemplate) (ou nosso [modelo de revisão em espanhol](#reviewtemplatees)) e usá-lo como uma lista de verificação de alto nível. Além de marcar os critérios mínimos, pedimos que você forneça comentários gerais abordando o seguinte: + +- O código está em conformidade com os princípios gerais do [Guia de revisão da Mozilla](https://mozillascience.github.io/codeReview/review.html)? +- O pacote está de acordo com os requisitos do [guia de embalagem da rOpenSci](#building)? +- Você acha que há melhorias que poderiam ser feitas no estilo do código? +- Há duplicação de código no pacote que deve ser reduzida? +- Há melhorias na interface do usuário que poderiam ser feitas? +- Você poderia fazer melhorias no desempenho? +- A documentação (instruções de instalação/vinhetas/exemplos/demonstrações) é clara e suficiente? Você usa o princípio de *vários pontos de entrada* ou seja, leva em conta o fato de que qualquer parte da documentação pode ser o primeiro encontro do usuário com o pacote e/ou com a ferramenta/dados que ele contém? +- As funções e os argumentos foram nomeados para trabalharem juntos e formarem uma API de programação comum e lógica que seja fácil de ler e de autocompletar? +- Se você tiver seus próprios dados/problemas relevantes, analise-os com o pacote. Você poderá encontrar arestas e casos de uso nos quais o autor não pensou. + +Seja respeitoso e gentil com os autores em suas avaliações. Nosso [código de conduta](#code-of-conduct) é obrigatório para todos os envolvidos em nosso processo de avaliação. Esperamos que você envie sua avaliação em até 3 semanas, dependendo do prazo definido pelo editor. Entre em contato com o editor diretamente ou no tópico de envio para informá-lo sobre possíveis atrasos. + +Incentivamos você a usar ferramentas automatizadas para facilitar a revisão. Isso inclui: + +- Verificar o relatório inicial do pacote gerado pelo nosso `@ropensci-review-bot`. +- Verificar os registros do pacote em seus serviços de integração contínua (GitHub Actions, Codecov, etc.) +- Execução `devtools::check()` e `devtools::test()` no pacote para localizar quaisquer erros que possam ter passado despercebidos no sistema do autor. +- Verificar se a omissão de testes é justificada (por exemplo `skip_on_cran()` testes que fazem solicitações reais de API vs. ignorar todos os testes em um sistema operacional). +- Se o pacote não for enviado por meio do branch padrão/principal, lembre-se de mudar para o branch de revisão enviado antes de iniciar sua revisão. Nesse caso, você também terá que pesquisar o pacote localmente, pois a pesquisa no GitHub é limitada ao branch padrão. Além disso, a documentação hospedada em um branch `pkgdown` não está necessariamente atualizada, e recomendamos que você inspecione a documentação do pacote localmente, executando `pkgdown::build_site()`. + +Os revisores também podem gerar novamente os resultados da verificação de pacotes a partir de `@ropensci-review-bot` a qualquer momento, emitindo um único comentário em um problema de revisão: `@ropensci-review-bot check package`. + +### Interações fora da linha {#off-thread-interactions} + +Se você interagiu com os autores do pacote e falou sobre a revisão fora de um tópico de revisão (em chats, mensagens diretas, pessoalmente, problemas no repositório do projeto), certifique-se de que sua revisão capture e/ou vincule elementos dessas conversas que sejam relevantes para o processo. + +### Experiência de revisores anteriores {#experience-from-past-reviewers} + +Os avaliadores iniciantes podem achar útil ler (sobre) algumas avaliações anteriores. Em geral, você pode encontrar tópicos de envio de pacotes integrados [aqui](https://github.com/ropensci/software-review/issues?q=is%3Aissue+is%3Aclosed+label%3A6%2Fapproved). Aqui estão alguns exemplos escolhidos de avaliações (observe que suas avaliações não precisam ser tão longas quanto esses exemplos): + +- `rtika` [revisão 1](https://github.com/ropensci/software-review/issues/191#issuecomment-367166658) e [revisão2](https://github.com/ropensci/software-review/issues/191#issuecomment-368254623) + +- `NLMR` [revisão 1](https://github.com/ropensci/software-review/issues/188#issuecomment-368042693) e [revisão2](https://github.com/ropensci/software-review/issues/188#issuecomment-369310831) + +- `bowerbird` [comentário pré-revisão](https://github.com/ropensci/software-review/issues/139#issuecomment-322713737), [revisão 1](https://github.com/ropensci/software-review/issues/139#issuecomment-342380870), [revisão 2](https://github.com/ropensci/software-review/issues/139#issuecomment-342724843). + +- `rusda` [revisão](https://github.com/ropensci/software-review/issues/18#issuecomment-120445737) (de antes de termos um modelo de avaliação) + +Você pode ler publicações de blog escritas por avaliadores sobre suas experiências [por meio deste link](https://ropensci.org/tags/reviewer/). Em particular, em [esta postagem do blog de Mara Averick](https://ropensci.org/blog/2017/08/22/first-package-review/) leia sobre o papel de "usuário ingênuo" que um revisor pode assumir para fornecer feedback útil mesmo sem ser especialista no tópico ou na implementação do pacote, perguntando a si mesmo *"O que eu achava que essa coisa faria? Ela faz isso? Quais são as coisas que me assustam?"*. Em [outra postagem do blog](https://ropensci.org/blog/2017/09/08/first-review-experiences/) Verena Haunschmid explica como ela alternou entre usar o pacote e verificar seu código. + +Como ex-revisora e autora do pacote [Adam Sparks](https://adamhsparks.netlify.app/) [escreveu o seguinte](https://twitter.com/adamhsparks/status/898132036451303425) "\[escreva\] uma boa crítica da estrutura do pacote e das práticas recomendadas de codificação. Se você souber como fazer algo melhor, diga-me. É fácil perder oportunidades de documentação como desenvolvedor; como revisor, você tem uma visão diferente. Você é um usuário que pode dar feedback. O que não está claro no pacote? Como você pode deixar isso mais claro? Se você estiver usando-o pela primeira vez, é fácil? Você conhece outro pacote R que talvez eu devesse usar? Ou há algum que eu esteja usando e que talvez não devesse usar? Se você puder contribuir com o pacote, ofereça." + +### Pacote de ajuda para revisores {#helper-package-for-reviewers} + +Se estiver trabalhando no RStudio, você pode otimizar o fluxo de trabalho de revisão usando o pacote [`pkgreviewr` pacote](https://github.com/ropensci-org/pkgreviewr) criado pela editora associada Anna Krystalli. Digamos que você tenha aceitado revisar o `refnet` pacote, você escreveria + +``` +remotes::install_github("ropensci-org/pkgreviewr") +library(pkgreviewr) +pkgreview_create(pkg_repo = "embruna/refnet", + review_parent = "~/Documents/workflows/rOpenSci/reviews/") +``` + +e + +- o repositório do GitHub do `refnet` será clonado. +- um projeto de revisão será criado, contendo um bloco de notas para você preencher e o modelo de revisão. +- Observe que, se o pacote não for enviado por meio da ramificação padrão/principal, você precisará mudar para a ramificação enviada antes de iniciar a revisão. + +### Comentários sobre o processo {#feedback-on-the-process} + +Incentivamos você a fazer perguntas e fornecer feedback sobre o processo de revisão em nosso [fórum](https://discuss.ropensci.org). + +## Envio da revisão {#submitreview} + +- Quando sua revisão estiver concluída, cole-a como um comentário no pacote software-review issue. +- Outros comentários são bem-vindos na mesma edição. Esperamos que as revisões de pacotes funcionem como uma conversa contínua com os autores, em vez de uma única rodada de revisões típica de manuscritos acadêmicos. +- Você também pode enviar problemas ou pull requests diretamente para o repositório de pacotes, se preferir, mas, se o fizer, comente sobre eles e coloque um link para eles no tópico de comentários do repositório de revisão de software para que tenhamos um registro centralizado e o texto da sua revisão. +- Inclua uma estimativa de quantas horas você gastou na revisão. + +## Acompanhamento da avaliação {#followupreviewer} + +Os autores devem responder dentro de duas semanas com as alterações feitas no pacote em resposta à sua avaliação. Nesse estágio, pedimos que você responda se as alterações abordam suficientemente os problemas levantados na sua revisão. Incentivamos a discussão contínua entre autores de pacotes e revisores, e você também pode pedir aos editores que esclareçam os problemas no tópico de revisão. + +Você usará a seção [modelo de aprovação](#approval2template). + + From 89fdf73e0795d98e6adaaa9a5747257bb6da2276 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Mon, 25 Nov 2024 22:37:02 +0100 Subject: [PATCH 02/12] R2 chunk 7 --- softwarereview_reviewer.pt.Rmd | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index 1dcddaaa8..ccb59d27f 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -1,23 +1,20 @@ --- -aliases: reviewerguide.html +aliases: + - reviewerguide.html --- -# Guia para revisores {#reviewerguide} +# Guia para Revisores {#reviewerguide} ```{block, type="summaryblock"} -Obrigado por você ter aceitado revisar um pacote para a rOpenSci! Este capítulo consiste em nossas diretrizes para [preparar](#preparereview), [enviar](#submitreview) e [acompanhar](#followupreviewer) a sua revisão. +Obrigado por aceitar revisar um pacote para a rOpenSci! Este capítulo consiste em nossas diretrizes para [preparar](#preparereview), [enviar](#submitreview) e [acompanhar](#followupreviewer) a sua revisão. Você pode entrar em contato com o editor responsável pela submissão para esclarecer qualquer dúvida que tenha sobre o processo ou sobre a sua revisão. -Esforce-se para concluir sua avaliação em até 3 semanas após a aceitação da solicitação de avaliação. Procuraremos lembrar os revisores das datas de vencimento futuras e passadas. Os editores podem designar -Os editores podem designar revisores adicionais ou alternativos se uma revisão estiver excessivamente atrasada. +Por favor tente concluir sua avaliação em até 3 semanas após aceitar uma solicitação de avaliação. Nós procuraremos lembrar os revisores das datas de entrega futuras e passadas. Os editores podem designar revisores adicionais ou substitutos se uma revisão estiver excessivamente atrasada. -A comunidade do **rOpenSci é o nosso melhor patrimônio. -Nosso objetivo é que as revisões sejam abertas, não contraditórias e focadas na melhoria da qualidade do software. -Seja respeitoso e gentil! -Consulte nosso guia de revisores e o [código de conduta] (https://ropensci.org/code-of-conduct/) para obter mais informações.** Você pode encontrar mais informações em nosso guia de revisores. +**A comunidade do rOpenSci é o nosso melhor patrimônio. Nosso objetivo é que as revisões sejam abertas, não contraditórias e focadas na melhoria da qualidade do software. Seja respeitoso e gentil! Consulte nosso guia de revisores e [código de conduta] (https://ropensci.org/code-of-conduct/) para obter mais informações. Você pode encontrar mais informações em nosso guia de revisores.** -_Se você usar nossos padrões/listas de verificação etc. ao revisar um software em outro lugar, informe aos destinatários (por exemplo, editores de periódicos, estudantes, revisão interna de código) que eles vieram da rOpenSci e nos informe em [nosso fórum público] (https://discuss.ropensci.org/c/usecases) ou [em particular por e-mail] (https://ropensci.org/contact/). +_Se você usar nossos guias/listas de verificação, etc. ao revisar um software em outra plataforma, informe aos interessados (e.g. editores de periódicos, estudantes, revisão interna de código) que aqueles vieram da rOpenSci e nos informe em nosso [fórum público] (https://discuss.ropensci.org/c/usecases) ou em [particular por e-mail] (https://ropensci.org/contact/)._ ``` ## Como voluntário como revisor {#volunteering-as-a-reviewer} From 45b7abbb29418ad9ecc9d5a1cd95c808ee162d22 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Mon, 25 Nov 2024 23:01:11 +0100 Subject: [PATCH 03/12] R2 chunk 7.1 --- softwarereview_reviewer.pt.Rmd | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index ccb59d27f..57b83058f 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -17,17 +17,15 @@ Por favor tente concluir sua avaliação em até 3 semanas após aceitar uma sol _Se você usar nossos guias/listas de verificação, etc. ao revisar um software em outra plataforma, informe aos interessados (e.g. editores de periódicos, estudantes, revisão interna de código) que aqueles vieram da rOpenSci e nos informe em nosso [fórum público] (https://discuss.ropensci.org/c/usecases) ou em [particular por e-mail] (https://ropensci.org/contact/)._ ``` -## Como voluntário como revisor {#volunteering-as-a-reviewer} +## Voluntariando como revisor {#volunteering-as-a-reviewer} -Obrigado pelo seu desejo de participar da revisão por pares do software rOpenSci como revisor! +Obrigado pelo seu desejo de participar como revisor da revisão por pares do software rOpenSci! -Por favor, preencha nosso [formulário de voluntariado](https://ropensci.org/software-reviewer). +Por favor preencha nosso [formulário de voluntariado](https://ropensci.org/software-reviewer). -Se você vir um envio atual que seja particularmente relevante para seus interesses, envie um e-mail para `info@ropensci.org` incluindo o nome do pacote, o URL do problema do envio e o nome do editor designado. -No entanto, lembre-se de que os convites para revisores são mantidos a critério do editor, e é bem possível que o editor já tenha enviado um e-mail para as pessoas. -Não se voluntarie para todas as edições e não se voluntarie por meio da interface do GitHub. +Se você encontrar um envio atual que seja particularmente relevante aos seus interesses, envie um e-mail para `info@ropensci.org` incluindo o nome do pacote, o URL do problema do envio e o nome do editor designado. No entanto, lembre-se de que os convites para revisores são mantidos a critério do editor, sendo possível que o editor já tenha enviado e-mails a outras pessoas. Por favor não se voluntarie em todas as edições e por meio da interface do GitHub. -Para outras maneiras de contribuir, consulte [Guia de contribuição do rOpenSci](https://contributing.ropensci.org/). +Para outras maneiras de contribuir, consulte o [guia de contribuição do rOpenSci](https://contributing.ropensci.org/). ## Preparando sua revisão {#preparereview} From 3ba1fe652bb356e364dcca188593e523c7be995d Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Mon, 25 Nov 2024 23:07:29 +0100 Subject: [PATCH 04/12] R2 chunk 7.2 --- softwarereview_reviewer.pt.Rmd | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index 57b83058f..d87f04696 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -29,8 +29,7 @@ Para outras maneiras de contribuir, consulte o [guia de contribuição do rOpenS ## Preparando sua revisão {#preparereview} -As revisões devem ser baseadas na versão mais recente do GitHub no branch padrão, a menos que indicado de outra forma pelos autores do pacote. -Todos os envios acionam um relatório detalhado sobre a estrutura e a funcionalidade do pacote, gerado por [nosso `pkgcheck` pacote](https://docs.ropensci.org/pkgcheck/). Se o pacote tiver sido alterado substancialmente desde as últimas verificações, você poderá solicitar uma nova verificação com o comando `@ropensci-review-bot check package`. Observe que, ao instalar o pacote para revisá-lo, você deve se certificar de que tem todas as dependências disponíveis (por exemplo, execute `pak::pak()`). +As revisões devem ser baseadas na versão mais recente do GitHub no _branch_ padrão, a menos que indicado de outra forma pelos autores do pacote. Todos os envios acionam um relatório detalhado sobre a estrutura e a funcionalidade do pacote, gerado por nosso [`pkgcheck` pacote](https://docs.ropensci.org/pkgcheck/). Se o pacote tiver sido alterado substancialmente desde as últimas verificações, você poderá solicitar uma nova verificação com o comando `@ropensci-review-bot check package`. Note que, ao instalar o pacote para revisá-lo, você deve se certificar de que tem todas as dependências estão disponíveis (por exemplo, execute `pak::pak()`). ### Diretrizes gerais {#general-guidelines} From 31188372cafe5b1c6a9da12f8c00a8447e40591b Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Mon, 25 Nov 2024 23:38:25 +0100 Subject: [PATCH 05/12] R2 chunk 7.2.1 --- softwarereview_reviewer.pt.Rmd | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index d87f04696..4a3738754 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -33,29 +33,29 @@ As revisões devem ser baseadas na versão mais recente do GitHub no _branch_ pa ### Diretrizes gerais {#general-guidelines} -Para revisar um pacote, comece copiando nosso [modelo de revisão](#reviewtemplate) (ou nosso [modelo de revisão em espanhol](#reviewtemplatees)) e usá-lo como uma lista de verificação de alto nível. 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 nosso [modelo de revisão em espanhol](#reviewtemplatees)) e use-o como uma lista de verificação global. Além de marcar os critérios mínimos, pedimos que você forneça comentários gerais sobre: -- O código está em conformidade com os princípios gerais do [Guia de revisão da Mozilla](https://mozillascience.github.io/codeReview/review.html)? -- O pacote está de acordo com os requisitos do [guia de embalagem da rOpenSci](#building)? -- Você acha que há melhorias que poderiam ser feitas no estilo do código? +- O código está em conformidade com os princípios gerais do [guia de revisão da Mozilla](https://mozillascience.github.io/codeReview/review.html)? +- O pacote está em conformidade com o [guia de pacotes da rOpenSci](#building)? +- Há melhorias que poderiam ser feitas no estilo do código? - Há duplicação de código no pacote que deve ser reduzida? - Há melhorias na interface do usuário que poderiam ser feitas? -- Você poderia fazer melhorias no desempenho? -- A documentação (instruções de instalação/vinhetas/exemplos/demonstrações) é clara e suficiente? Você usa o princípio de *vários pontos de entrada* ou seja, leva em conta o fato de que qualquer parte da documentação pode ser o primeiro encontro do usuário com o pacote e/ou com a ferramenta/dados que ele contém? +- Há melhorias no desempenho que poderiam ser feitas? +- A documentação (instruções de instalação, vinhetas, exemplos, demonstrações) é clara e suficiente? E ela usa o princípio de *vários pontos de entrada*, i.e., leva em conta o fato de que qualquer parte da documentação pode ser o primeiro encontro do usuário com o pacote e/ou com a ferramenta/dados que ele contém? - As funções e os argumentos foram nomeados para trabalharem juntos e formarem uma API de programação comum e lógica que seja fácil de ler e de autocompletar? -- Se você tiver seus próprios dados/problemas relevantes, analise-os com o pacote. Você poderá encontrar arestas e casos de uso nos quais o autor não pensou. +- Se você tiver seus próprios dados/problemas relevantes, analise-os com o pacote. Você poderá encontrar pontos fracos e casos de uso nos quais o autor não pensou. -Seja respeitoso e gentil com os autores em suas avaliações. Nosso [código de conduta](#code-of-conduct) é obrigatório para todos os envolvidos em nosso processo de avaliação. Esperamos que você envie sua avaliação em até 3 semanas, dependendo do prazo definido pelo editor. Entre em contato com o editor diretamente ou no tópico de envio para informá-lo sobre possíveis atrasos. +Por favor, seja respeitoso e gentil com os autores em suas avaliações. Nosso [código de conduta](#code-of-conduct) é obrigatório para todos os envolvidos em nosso processo de avaliação. Esperamos que você envie sua avaliação em até 3 semanas, dependendo do prazo definido pelo editor. Entre em contato com o editor diretamente ou no _thread_ de envio para informá-lo sobre possíveis atrasos. -Incentivamos você a usar ferramentas automatizadas para facilitar a revisão. Isso inclui: +Incentivamos você a usar ferramentas automatizadas para facilitar a revisão. Isso inclui: - Verificar o relatório inicial do pacote gerado pelo nosso `@ropensci-review-bot`. - Verificar os registros do pacote em seus serviços de integração contínua (GitHub Actions, Codecov, etc.) - Execução `devtools::check()` e `devtools::test()` no pacote para localizar quaisquer erros que possam ter passado despercebidos no sistema do autor. -- Verificar se a omissão de testes é justificada (por exemplo `skip_on_cran()` testes que fazem solicitações reais de API vs. ignorar todos os testes em um sistema operacional). -- Se o pacote não for enviado por meio do branch padrão/principal, lembre-se de mudar para o branch de revisão enviado antes de iniciar sua revisão. Nesse caso, você também terá que pesquisar o pacote localmente, pois a pesquisa no GitHub é limitada ao branch padrão. Além disso, a documentação hospedada em um branch `pkgdown` não está necessariamente atualizada, e recomendamos que você inspecione a documentação do pacote localmente, executando `pkgdown::build_site()`. +- Verificar se a omissão (_skipping_) de testes é justificada (e.g. `skip_on_cran()` realiza solicitações reais de API vs. ignora todos os testes em um sistema operacional). +- Se o pacote não for enviado por meio do _branch_ padrão/principal, lembre-se de mudar para o _branch_ de revisão enviado antes de iniciar sua revisão. Nesse caso, você também deverá pesquisar o pacote localmente, pois a pesquisa no GitHub é limitada ao _branch_ padrão. Além disso, documentações hospedadas em um website tipo `pkgdown` não são necessariamente atualizadas, por isso recomendamos que você inspecione a documentação do pacote localmente, executando `pkgdown::build_site()`. -Os revisores também podem gerar novamente os resultados da verificação de pacotes a partir de `@ropensci-review-bot` a qualquer momento, emitindo um único comentário em um problema de revisão: `@ropensci-review-bot check package`. +Os revisores também podem gerar novamente os resultados da verificação de pacotes a partir de `@ropensci-review-bot` a qualquer momento, emitindo um único comentário em um problema de revisão (_review issue_): `@ropensci-review-bot check package`. ### Interações fora da linha {#off-thread-interactions} From 135bc7a1f8dcda01f47eb47a8287a2d295346763 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Tue, 26 Nov 2024 20:52:00 +0100 Subject: [PATCH 06/12] R2 chunk 7.2.2 --- softwarereview_reviewer.pt.Rmd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index 4a3738754..e48ff7aab 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -57,9 +57,9 @@ Incentivamos você a usar ferramentas automatizadas para facilitar a revisão. I Os revisores também podem gerar novamente os resultados da verificação de pacotes a partir de `@ropensci-review-bot` a qualquer momento, emitindo um único comentário em um problema de revisão (_review issue_): `@ropensci-review-bot check package`. -### Interações fora da linha {#off-thread-interactions} +### Interações em outros contextos {#off-thread-interactions} -Se você interagiu com os autores do pacote e falou sobre a revisão fora de um tópico de revisão (em chats, mensagens diretas, pessoalmente, problemas no repositório do projeto), certifique-se de que sua revisão capture e/ou vincule elementos dessas conversas que sejam relevantes para o processo. +Se você interagiu com os autores do pacote e falou sobre a revisão fora do contexto da revisão (em _chats_, mensagens diretas, pessoalmente, ou por problemas [_issues_] no repositório do projeto), certifique-se de que sua revisão capture e/ou vincule elementos dessas conversas que sejam relevantes para o processo. ### Experiência de revisores anteriores {#experience-from-past-reviewers} From 59aa2a97b4064e7a9b8977db915704aeb5fd0fe2 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Tue, 26 Nov 2024 21:14:12 +0100 Subject: [PATCH 07/12] R2 chunk 7.2.3 --- softwarereview_reviewer.pt.Rmd | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index e48ff7aab..13af5e790 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -63,19 +63,19 @@ Se você interagiu com os autores do pacote e falou sobre a revisão fora do con ### Experiência de revisores anteriores {#experience-from-past-reviewers} -Os avaliadores iniciantes podem achar útil ler (sobre) algumas avaliações anteriores. Em geral, você pode encontrar tópicos de envio de pacotes integrados [aqui](https://github.com/ropensci/software-review/issues?q=is%3Aissue+is%3Aclosed+label%3A6%2Fapproved). Aqui estão alguns exemplos escolhidos de avaliações (observe que suas avaliações não precisam ser tão longas quanto esses exemplos): +Revisores iniciantes podem achar útil ler (sobre) algumas revisões anteriores. Em geral, você pode encontrar tópicos de envio de pacotes integrados [aqui](https://github.com/ropensci/software-review/issues?q=is%3Aissue+is%3Aclosed+label%3A6%2Fapproved). Aqui estão alguns exemplos escolhidos de revisões (observe que suas revisões não precisam ser tão longas quanto estes exemplos): - `rtika` [revisão 1](https://github.com/ropensci/software-review/issues/191#issuecomment-367166658) e [revisão2](https://github.com/ropensci/software-review/issues/191#issuecomment-368254623) - `NLMR` [revisão 1](https://github.com/ropensci/software-review/issues/188#issuecomment-368042693) e [revisão2](https://github.com/ropensci/software-review/issues/188#issuecomment-369310831) -- `bowerbird` [comentário pré-revisão](https://github.com/ropensci/software-review/issues/139#issuecomment-322713737), [revisão 1](https://github.com/ropensci/software-review/issues/139#issuecomment-342380870), [revisão 2](https://github.com/ropensci/software-review/issues/139#issuecomment-342724843). +- `bowerbird` [comentário pré-revisão](https://github.com/ropensci/software-review/issues/139#issuecomment-322713737), [revisão 1](https://github.com/ropensci/software-review/issues/139#issuecomment-342380870), [revisão 2](https://github.com/ropensci/software-review/issues/139#issuecomment-342724843) -- `rusda` [revisão](https://github.com/ropensci/software-review/issues/18#issuecomment-120445737) (de antes de termos um modelo de avaliação) +- `rusda` [revisão](https://github.com/ropensci/software-review/issues/18#issuecomment-120445737) (antes de termos um modelo de revisão) -Você pode ler publicações de blog escritas por avaliadores sobre suas experiências [por meio deste link](https://ropensci.org/tags/reviewer/). Em particular, em [esta postagem do blog de Mara Averick](https://ropensci.org/blog/2017/08/22/first-package-review/) leia sobre o papel de "usuário ingênuo" que um revisor pode assumir para fornecer feedback útil mesmo sem ser especialista no tópico ou na implementação do pacote, perguntando a si mesmo *"O que eu achava que essa coisa faria? Ela faz isso? Quais são as coisas que me assustam?"*. Em [outra postagem do blog](https://ropensci.org/blog/2017/09/08/first-review-experiences/) Verena Haunschmid explica como ela alternou entre usar o pacote e verificar seu código. +Você pode ler publicações de blog escritas por revisores sobre suas experiências por meio deste [link](https://ropensci.org/tags/reviewer/). Em particular, nesta [postagem do blog de Mara Averick](https://ropensci.org/blog/2017/08/22/first-package-review/) leia sobre o papel de "usuário ingênuo" que um revisor pode assumir para fornecer feedback útil, mesmo sem ser especialista no tópico ou na implementação do pacote, ao perguntar a si mesmo *"O que eu achei que essa coisa faria? Ela faz isso? Quais são as coisas que me assustam?"*. Em [outra postagem do blog](https://ropensci.org/blog/2017/09/08/first-review-experiences/), Verena Haunschmid explica como ela alternou entre usar o pacote e verificar seu código. -Como ex-revisora e autora do pacote [Adam Sparks](https://adamhsparks.netlify.app/) [escreveu o seguinte](https://twitter.com/adamhsparks/status/898132036451303425) "\[escreva\] uma boa crítica da estrutura do pacote e das práticas recomendadas de codificação. Se você souber como fazer algo melhor, diga-me. É fácil perder oportunidades de documentação como desenvolvedor; como revisor, você tem uma visão diferente. Você é um usuário que pode dar feedback. O que não está claro no pacote? Como você pode deixar isso mais claro? Se você estiver usando-o pela primeira vez, é fácil? Você conhece outro pacote R que talvez eu devesse usar? Ou há algum que eu esteja usando e que talvez não devesse usar? Se você puder contribuir com o pacote, ofereça." +Tanto como ex-revisor e autor de pacote, [Adam Sparks](https://adamhsparks.netlify.app/) [escreveu o seguinte](https://twitter.com/adamhsparks/status/898132036451303425) "\[escreva\] uma boa crítica da estrutura do pacote e das práticas recomendadas de codificação. Se você sabe como fazer algo melhor, diga-me. É fácil perder oportunidades de documentação como desenvolvedor; como revisor, você tem uma visão diferente. Você é um usuário que pode dar _feedback_. O que não está claro no pacote? Como você pode deixar isso mais claro? Se você estiver usando-o pela primeira vez, é fácil? Você conhece outro pacote de R que talvez eu devesse usar? Ou há algum que eu esteja usando e que talvez não devesse usar? Se você puder contribuir com o pacote, ofereça." ### Pacote de ajuda para revisores {#helper-package-for-reviewers} From f696b859708e765dcca0f8474944d9f37a96b1d1 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Tue, 26 Nov 2024 21:20:35 +0100 Subject: [PATCH 08/12] R2 chunk 7.2.4 --- softwarereview_reviewer.pt.Rmd | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index 13af5e790..298d6d7d6 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -79,7 +79,7 @@ Tanto como ex-revisor e autor de pacote, [Adam Sparks](https://adamhsparks.netli ### Pacote de ajuda para revisores {#helper-package-for-reviewers} -Se estiver trabalhando no RStudio, você pode otimizar o fluxo de trabalho de revisão usando o pacote [`pkgreviewr` pacote](https://github.com/ropensci-org/pkgreviewr) criado pela editora associada Anna Krystalli. Digamos que você tenha aceitado revisar o `refnet` pacote, você escreveria +Se estiver trabalhando no RStudio, você pode otimizar seu fluxo de trabalho de revisão usando o pacote [`pkgreviewr`](https://github.com/ropensci-org/pkgreviewr) criado pela editora associada Anna Krystalli. Digamos que você tenha aceitado revisar o pacote `refnet`, você escreveria ``` remotes::install_github("ropensci-org/pkgreviewr") @@ -90,9 +90,9 @@ pkgreview_create(pkg_repo = "embruna/refnet", e -- o repositório do GitHub do `refnet` será clonado. -- um projeto de revisão será criado, contendo um bloco de notas para você preencher e o modelo de revisão. -- Observe que, se o pacote não for enviado por meio da ramificação padrão/principal, você precisará mudar para a ramificação enviada antes de iniciar a revisão. +- o repositório do pacote `refnet` no GitHub será clonado +- um projeto de revisão será criado, contendo um bloco de notas para você preencher e o modelo de revisão +- observe que, se o pacote não for enviado por meio da ramificação padrão/principal, você precisará mudar para a ramificação enviada antes de iniciar sua revisão ### Comentários sobre o processo {#feedback-on-the-process} From ae4df6393ddb7f8515ca223665909ea2bcd01c40 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Tue, 26 Nov 2024 21:22:12 +0100 Subject: [PATCH 09/12] R2 chunk 7.2.5 --- softwarereview_reviewer.pt.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index 298d6d7d6..38abb3e34 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -96,7 +96,7 @@ e ### Comentários sobre o processo {#feedback-on-the-process} -Incentivamos você a fazer perguntas e fornecer feedback sobre o processo de revisão em nosso [fórum](https://discuss.ropensci.org). +Incentivamos você a fazer perguntas e fornecer _feedback_ sobre o processo de revisão em nosso [fórum](https://discuss.ropensci.org). ## Envio da revisão {#submitreview} From b2822a583e92dfbc451051864dc823f80a212609 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Tue, 26 Nov 2024 21:34:12 +0100 Subject: [PATCH 10/12] R2 chunk 7.3 --- softwarereview_reviewer.pt.Rmd | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index 38abb3e34..e99d8a818 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -100,9 +100,9 @@ Incentivamos você a fazer perguntas e fornecer _feedback_ sobre o processo de r ## Envio da revisão {#submitreview} -- Quando sua revisão estiver concluída, cole-a como um comentário no pacote software-review issue. -- Outros comentários são bem-vindos na mesma edição. Esperamos que as revisões de pacotes funcionem como uma conversa contínua com os autores, em vez de uma única rodada de revisões típica de manuscritos acadêmicos. -- Você também pode enviar problemas ou pull requests diretamente para o repositório de pacotes, se preferir, mas, se o fizer, comente sobre eles e coloque um link para eles no tópico de comentários do repositório de revisão de software para que tenhamos um registro centralizado e o texto da sua revisão. +- Quando sua revisão estiver concluída, cole-a como um comentário na secção de problemas do pacote (_package software-review issue_). +- Comentários adicionais são bem-vindos na mesma edição. Esperamos que as revisões de pacotes funcionem como uma conversa contínua com os autores, em vez de uma única rodada de revisões típica de manuscritos acadêmicos. +- Você também pode enviar problemas ou _pull requests_ diretamente para o repositório do pacote, se preferir, mas, se o fizer, comente sobre eles e coloque um link para eles no tópico de comentários do repositório de revisão de software para que tenhamos um registro centralizado e o texto da sua revisão. - Inclua uma estimativa de quantas horas você gastou na revisão. ## Acompanhamento da avaliação {#followupreviewer} From 83bc04d9cd07ef0544d1ac8078be7255ba543243 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Tue, 26 Nov 2024 21:38:34 +0100 Subject: [PATCH 11/12] R2 chunk 7.4 --- softwarereview_reviewer.pt.Rmd | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index e99d8a818..3e951c6ac 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -105,10 +105,10 @@ Incentivamos você a fazer perguntas e fornecer _feedback_ sobre o processo de r - Você também pode enviar problemas ou _pull requests_ diretamente para o repositório do pacote, se preferir, mas, se o fizer, comente sobre eles e coloque um link para eles no tópico de comentários do repositório de revisão de software para que tenhamos um registro centralizado e o texto da sua revisão. - Inclua uma estimativa de quantas horas você gastou na revisão. -## Acompanhamento da avaliação {#followupreviewer} +## Acompanhamento da revisão {#followupreviewer} -Os autores devem responder dentro de duas semanas com as alterações feitas no pacote em resposta à sua avaliação. Nesse estágio, pedimos que você responda se as alterações abordam suficientemente os problemas levantados na sua revisão. Incentivamos a discussão contínua entre autores de pacotes e revisores, e você também pode pedir aos editores que esclareçam os problemas no tópico de revisão. +Os autores devem responder dentro de 2 semanas com alterações feitas no pacote em resposta a sua avaliação. Nesse estágio, pedimos que você responda se as alterações abordam suficientemente os problemas levantados na sua revisão. Incentivamos a discussão contínua entre autores de pacotes e revisores, e você também pode pedir aos editores que esclareçam os problemas no tópico (_thread_) de revisão. -Você usará a seção [modelo de aprovação](#approval2template). +Você usará o [modelo de aprovação](#approval2template). From 15e6961dea8e5b5b5c3d14ab0b30a7f630a8fe9f Mon Sep 17 00:00:00 2001 From: Yanina Bellini Saibene Date: Sat, 14 Dec 2024 22:36:32 -0300 Subject: [PATCH 12/12] Apply suggestions from code review --- softwarereview_reviewer.pt.Rmd | 4 ---- 1 file changed, 4 deletions(-) diff --git a/softwarereview_reviewer.pt.Rmd b/softwarereview_reviewer.pt.Rmd index 3e951c6ac..ec58c76bd 100644 --- a/softwarereview_reviewer.pt.Rmd +++ b/softwarereview_reviewer.pt.Rmd @@ -1,7 +1,3 @@ ---- -aliases: - - reviewerguide.html ---- # Guia para Revisores {#reviewerguide}