From 331f1a3f5f22fbc9527c5883b82b08121a3c4492 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Fri, 29 Nov 2024 10:27:47 +0100 Subject: [PATCH 01/18] R1 chunk 8.0 --- softwarereview_editor.pt.Rmd | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/softwarereview_editor.pt.Rmd b/softwarereview_editor.pt.Rmd index 741bdbbb2..fe575e4c5 100644 --- a/softwarereview_editor.pt.Rmd +++ b/softwarereview_editor.pt.Rmd @@ -1,19 +1,19 @@ --- -aliases: editorguide.html +aliases: + - editorguide.html --- -# Guia para editores {#editorguide} +# Guia para Editores {#editorguide} ```{block, type="summaryblock"} -A revisão por pares de software na rOpenSci é gerenciada por uma equipe de editores. Estamos testando -um sistema rotativo de Editor-chefe (EiC). +A revisão por pares de software na rOpenSci é gerenciada por uma equipe de editores. Estamos testando um sistema rotativo de Editor-Chefe (do inglês EiC). -Este capítulo apresenta as responsabilidades [do Editor-chefe] (#eicchecklist), de [qualquer editor responsável por uma submissão] (#editorchecklist), [como responder a uma submissão fora do escopo] (#outofscoperesponse) e [como gerenciar o lançamento de um guia de desenvolvimento] (#bookrelease). +Este capítulo apresenta as responsabilidades do [Editor-Chefe] (#eicchecklist), de [qualquer editor responsável por uma submissão] (#editorchecklist), [como responder a uma submissão fora do escopo] (#outofscoperesponse) e [como gerenciar o lançamento de um guia de desenvolvimento] (#bookrelease). -Se você for um editor convidado, obrigado por ajudar! Entre em contato com o editor que o convidou para lidar com um envio para esclarecer qualquer dúvida que você possa ter. +Se você for um editor convidado, obrigado por ajudar! Entre em contato com o editor que o convidou para lidar com uma submissão para esclarecer qualquer dúvida que você possa ter. ``` -> Sempre presuma que os participantes do sistema de revisão de software (colegas editores, remetentes, revisores) estão fazendo o melhor que podem e comunique-se com elegância, especialmente ao perguntar por que algo está atrasado. +> Sempre presuma que os participantes do sistema de revisão de software (colegas editores, quem envia submissões, revisores) estão fazendo o melhor que podem e que se comunicam adequadamente, especialmente ao perguntar por que algo está atrasado. ## Responsabilidades dos editores {#editors-responsibilities} From dd953b35d26ffbbadb17c5ac95d1b8ad040a7768 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Fri, 29 Nov 2024 10:47:44 +0100 Subject: [PATCH 02/18] R1 chunk 8.1 --- softwarereview_editor.pt.Rmd | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/softwarereview_editor.pt.Rmd b/softwarereview_editor.pt.Rmd index fe575e4c5..b7a1cfd7d 100644 --- a/softwarereview_editor.pt.Rmd +++ b/softwarereview_editor.pt.Rmd @@ -17,15 +17,15 @@ Se você for um editor convidado, obrigado por ajudar! Entre em contato com o ed ## Responsabilidades dos editores {#editors-responsibilities} -- Além de lidar com os pacotes (cerca de 4 por ano), os editores participam das decisões editoriais do grupo, como, por exemplo, se um pacote está dentro do escopo e determinar atualizações em nossas políticas. Geralmente, fazemos isso por meio do Slack, que esperamos que os editores possam verificar regularmente. +- Além de lidar com pacotes (cerca de 4 por ano), editores participam das decisões editoriais do grupo, como, por exemplo, se um pacote está dentro do escopo e determinam atualizações em nossas políticas. Geralmente, fazemos isso por meio do Slack, que esperamos que os editores possam verificar regularmente. -- Também fazemos um rodízio de [Responsabilidades do editor-chefe](#eicchecklist) (decisões de escopo de primeira passagem e designação de editores) entre a diretoria trimestralmente. +- Também fazemos um rodízio de [responsabilidades do Editor-Chefe](#eicchecklist) (decisões de escopo de primeira linha e designação de editores) entre a diretoria trimestralmente. -- Você não precisa acompanhar outros envios, mas se notar um problema com um pacote que está sendo tratado por outro editor, sinta-se à vontade para levantar esse problema diretamente com o outro editor ou publicar a preocupação no canal somente para editores no Slack. Exemplos: +- Você não precisa acompanhar outras submissões, mas se notar um problema com um pacote que está sendo tratado por outro editor, sinta-se à vontade para levantar esse problema diretamente com o outro editor ou publicar sua observação no canal de editores no Slack. Exemplos: - - Você sabe de um pacote sobreposto que ainda não foi mencionado no processo. - - Você vê uma pergunta para a qual tem uma resposta especializada que não foi dada depois de alguns dias (por exemplo, você sabe de uma publicação no blog que aborda como adicionar imagens aos documentos do pacote). - - Preocupações relacionadas, por exemplo, à velocidade do processo devem ser tratadas pelo editor-chefe, portanto, é a ele que você recorreria para essas perguntas. + - Você sabe de um pacote que gera conflitos que ainda não foi mencionado no processo. + - Você vê uma pergunta para a qual uma resposta especializada não foi dada depois de alguns dias (e.g., você sabe de uma publicação num blog que aborda como adicionar imagens a documentação de pacotes). + - Preocupações relacionadas à velocidade do processo devem ser tratadas pelo Editor-Chefe, portanto, é a ele que você recorreria para tais perguntas. ## Como lidar com a lista de verificação do editor {#editorchecklist} From 4919be6e04b1552adcdba1d003708fe313d69e47 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Fri, 29 Nov 2024 11:39:11 +0100 Subject: [PATCH 03/18] R1 chunk 8.2.1 --- softwarereview_editor.pt.Rmd | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/softwarereview_editor.pt.Rmd b/softwarereview_editor.pt.Rmd index b7a1cfd7d..d381ecb8a 100644 --- a/softwarereview_editor.pt.Rmd +++ b/softwarereview_editor.pt.Rmd @@ -31,21 +31,19 @@ Se você for um editor convidado, obrigado por ajudar! Entre em contato com o ed ### No momento do envio: {#upon-submission} -- Se você for o EiC ou o primeiro editor a responder, designe um editor com um comentário de `@ropensci-review-bot assign @username as editor`. Isso também adicionará a tag `1/editor-checks` à edição. -- Para envios estatísticos (identificáveis como "Tipo de envio: Estatísticas" no modelo da edição), adicione o rótulo "stats" à edição. -- O envio gerará automaticamente a saída de verificação de pacote do ropensci-review-bot, que deve ser examinada para verificar se há problemas pendentes (a maioria das exceções precisará ser justificada pelo autor no contexto específico de seu pacote). Se você quiser executar novamente as verificações após qualquer alteração no pacote, poste um comentário `@ropensci-review-bot check package`. -- O sistema de verificação é reconstruído toda terça-feira, às 00:01 UTC, e pode levar algumas horas. Se as verificações automáticas falharem nesse horário, aguarde algumas horas e tente novamente. -- Depois que as verificações automáticas forem lançadas, use o comando [modelo de editor](#editortemplate) para orientar as verificações iniciais e registrar sua resposta ao envio. Você também pode simplificar as verificações do editor usando a função [`pkgreviewr` pacote criado pela editora associada Anna Krystalli](https://docs.ropensci.org/pkgreviewr/articles/editors.html). Esforce-se para concluir as verificações e começar a procurar revisores dentro de 5 dias úteis. +- Se você for o EiC ou o primeiro editor a responder, designe um editor com um comentário `@ropensci-review-bot assign @username as editor`. Isso também adicionará a _tag_ `1/editor-checks` ao problema da edição (_issue_). +- Para submissões estatísticas (identificadas como _"Submission Type: Stats"_ no modelo da _issue_), adicione o rótulo _"stats"_ à edição. +- Uma submissão gerará automaticamente um relatório de verificação de pacote do ropensci-review-bot, que deve ser examinado para identificar se há problemas pendentes (a maioria das exceções deverá ser justificada pelo autor no contexto específico do seu pacote). Se você quiser executar novamente as verificações após qualquer alteração no pacote, poste o comentário `@ropensci-review-bot check package`. +- O sistema de verificação é reconstruído todas terças-feiras às 00:01 UTC, podendo levar algumas horas. Se verificações automáticas falharem nesse horário, aguarde algumas horas e tente novamente. +- Depois que as verificações automáticas forem lançadas, use o [modelo de editor](#editortemplate) para orientar as verificações iniciais e registrar sua resposta a submissão. Você também pode simplificar suas verificações de editor usando a função [`pkgreviewr` pacote criado pela editora associada Anna Krystalli](https://docs.ropensci.org/pkgreviewr/articles/editors.html). Por favor, tente concluir as verificações e começe a procurar revisores dentro de 5 dias úteis. - Verifique se o modelo foi preenchido corretamente. -- Verifique as políticas para [ajuste](#aims-and-scope) e [sobreposição](#overlap). - Inicie a discussão por meio do canal #software-review do Slack, se necessário, para casos extremos que não tenham sido detectados por verificações anteriores da EiC. - Se você rejeitar, consulte [esta seção](#outofscoperesponse) sobre como responder. -- Verifique se as partes obrigatórias do modelo estão completas. Caso contrário, direcione os autores para as instruções apropriadas. +- Verifique as políticas por [ajuste](#aims-and-scope) e [sobreposição](#overlap). Se necessário, inicie a discussão por meio do canal #software-review do Slack para casos extremos que não tenham sido detectados por verificações anteriores do EiC. Se houver rejeições, consulte [esta seção](#outofscoperesponse) sobre como responder. +- Verifique se as partes obrigatórias do modelo estão completas. Caso contrário, oriente os autores para as instruções apropriadas. - Para pacotes que precisam de integração contínua em várias plataformas (cf [critérios nesta seção do capítulo sobre CI](#whichci)), certifique-se de que o pacote seja testado em várias plataformas (tendo o pacote criado em vários sistemas operacionais por meio do GitHub Actions, por exemplo). -- Sempre que possível, ao solicitar alterações, direcione os autores para ferramentas automáticas, como [`usethis`](https://usethis.r-lib.org/) e [`styler`](https://styler.r-lib.org/) e para recursos on-line (seções deste guia, seções do [livro de pacotes do R](https://r-pkgs.org/)) para facilitar o uso de seus comentários. [Exemplo de verificações do editor](https://github.com/ropensci/software-review/issues/207#issuecomment-379909739). -- O ideal é que as observações que você fizer sejam resolvidas antes que os revisores comecem a revisar. -- Se as verificações iniciais mostrarem grandes lacunas, solicite alterações antes de designar os revisores. Se o autor mencionar que as alterações podem levar tempo, [aplique o rótulo de retenção digitando `@ropensci-review-bot put on hold`](#policiesreviewprocess). Você receberá um lembrete a cada 90 dias (na edição) para verificar com o(s) autor(es) do pacote. -- Se o pacote levantar um novo problema para a política do rOpenSci, inicie uma conversa no Slack ou abra uma discussão na seção [fórum do rOpenSci](https://discuss.ropensci.org/) para discuti-lo com outros editores ([exemplo de discussão de política](https://discuss.ropensci.org/t/overlap-policy-for-package-onboarding/368)). +- Sempre que possível, ao solicitar alterações, direcione os autores para ferramentas automáticas, como [`usethis`](https://usethis.r-lib.org/) e [`styler`](https://styler.r-lib.org/) e para recursos online (seções deste guia, seções do [livro de pacotes do R](https://r-pkgs.org/)) para facilitar o uso de seus comentários. [Exemplo de verificações de editor](https://github.com/ropensci/software-review/issues/207#issuecomment-379909739). +- O ideal é que você faça observações e estas sejam resolvidas antes que revisores comecem a revisar. +- Se as verificações iniciais mostrarem grandes lacunas, solicite alterações antes de designar os revisores. Se o autor mencionar que as alterações podem levar tempo, [aplique o rótulo de retenção digitando `@ropensci-review-bot put on hold`](#policiesreviewprocess). Você receberá um lembrete a cada 90 dias (na _issue_) para verificar com o(s) autor(es) do pacote. +- Se o pacote levantar um novo problema para a política de uso do rOpenSci, inicie uma conversa no Slack ou abra uma discussão na seção [fórum do rOpenSci](https://discuss.ropensci.org/) para discutí-lo com outros editores ([exemplo de discussão de política](https://discuss.ropensci.org/t/overlap-policy-for-package-onboarding/368)). ### Procure e designe dois revisores: {#look-for-and-assign-two-reviewers} From 5055132097211984ab79713bed13a2cc4de93ea7 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Mon, 2 Dec 2024 08:29:08 +0100 Subject: [PATCH 04/18] R1 chunk 8.2.2.1 --- softwarereview_editor.pt.Rmd | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/softwarereview_editor.pt.Rmd b/softwarereview_editor.pt.Rmd index d381ecb8a..eb6e71f3e 100644 --- a/softwarereview_editor.pt.Rmd +++ b/softwarereview_editor.pt.Rmd @@ -50,9 +50,8 @@ Se você for um editor convidado, obrigado por ajudar! Entre em contato com o ed #### Tarefas {#tasks} - Comente com `@ropensci-review-bot seeking reviewers`. -- Use o [modelo de e-mail](#reviewrequesttemplate) se necessário, para convidar os revisores - - Ao convidar os avaliadores, inclua algo como "se eu não tiver notícias suas em uma semana, presumirei que você não poderá avaliar", para dar um prazo claro para que você passe a procurar outra pessoa. -- Designe revisores com `@ropensci-review-bot assign @username as reviewer`. `add` também pode ser usado em vez de `assign`, e `to reviewers` (plural) em vez de `as reviewer` (singular). Portanto, o seguinte também é válido: `@ropensci-review-bot add @username to reviewers`. Um comando deve ser emitido para cada revisor. Se necessário posteriormente, remova os revisores com `@ropensci-review-bot remove @username from reviewers`. +- Use o [modelo de e-mail](#reviewrequesttemplate) se necessário, para convidar revisores. Ao convidar revisores, inclua algo como "se eu não tiver notícias suas em uma semana, presumirei que você não poderá fazer uma revisão", para dar um prazo claro no qual você irá procurar outra pessoa. +- Designe revisores com `@ropensci-review-bot assign @username as reviewer`. Em vez de `assign`, `add` também pode ser usado, assim como `to reviewers` (plural) em vez de `as reviewer` (singular). Portanto, o seguinte também é válido: `@ropensci-review-bot add @username to reviewers`. Um comando deve ser emitido para cada revisor. Se necessário posteriormente, remova revisores com `@ropensci-review-bot remove @username from reviewers`. - Se você quiser alterar a data de vencimento de uma revisão, use `@ropensci-review-bot set due date for @username to YYYY-MM-DD`. #### Como procurar revisores {#how-to-look-for-reviewers} From 2220762358477edd4e03869ebc9b3edcdd17e986 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Mon, 2 Dec 2024 08:42:58 +0100 Subject: [PATCH 05/18] R1 chunk 8.2.2.2.1 --- softwarereview_editor.pt.Rmd | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/softwarereview_editor.pt.Rmd b/softwarereview_editor.pt.Rmd index eb6e71f3e..6761a8100 100644 --- a/softwarereview_editor.pt.Rmd +++ b/softwarereview_editor.pt.Rmd @@ -60,14 +60,14 @@ Se você for um editor convidado, obrigado por ajudar! Entre em contato com o ed Como editor (convidado), use -- as possíveis sugestões feitas pelo(s) remetente(s), (embora os remetentes possam ter uma visão limitada dos tipos de especialização necessários. Sugerimos que você não use mais de um dos revisores sugeridos); -- o banco de dados Airtable de revisores e voluntários (consulte a próxima subseção); +- as possíveis sugestões feitas por quem envia submissões, (embora estes possam ter uma visão limitada dos tipos de especialização necessários; sugerimos que você não use mais de um dos revisores sugeridos). +- o banco de dados Airtable de revisores e voluntários (consulte a próxima subseção). - e os autores de [pacotes rOpenSci](https://ropensci.org/packages/). -Quando essas fontes de informação não forem suficientes, você poderá usar os pacotes rOpenSci, +Quando essas fontes de informação não forem suficientes, -- peça ideias a outros editores no Slack, -- procure usuários do pacote ou da fonte de dados/serviço de upstream ao qual o pacote se conecta (por meio da abertura de problemas no repositório, marcando-o com uma estrela, citando-o em artigos, falando sobre ele no Twitter). +- peça ideias a outros editores no Slack. +- procure usuários do pacote ou da fonte de dados/serviço upstream ao qual o pacote se conecta (por meio das _issues_ de abertura no repositório, marcando-o com uma estrela, citando-o em artigos, falando sobre ele na plataforma X). - Você também pode procurar por autores de pacotes relacionados em [r-pkg.org](https://r-pkg.org/). - R-Ladies tem um [diretório](https://rladies.org/directory/) especificando as habilidades e os interesses das pessoas listadas. - Você pode publicar uma solicitação de revisores nos canais #general e/ou #software-review no Slack do rOpenSci ou nas mídias sociais. From 436b7d01786bf97dd428a413639f9c2b9268c6df Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Mon, 2 Dec 2024 08:50:13 +0100 Subject: [PATCH 06/18] R1 chunk 8.2.2.2.2 --- softwarereview_editor.pt.Rmd | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/softwarereview_editor.pt.Rmd b/softwarereview_editor.pt.Rmd index 6761a8100..d8d35e51c 100644 --- a/softwarereview_editor.pt.Rmd +++ b/softwarereview_editor.pt.Rmd @@ -74,13 +74,11 @@ Quando essas fontes de informação não forem suficientes, ##### Dicas para a pesquisa de revisores no Airtable {#tips-for-reviewer-search-in-airtable} -Você pode usar filtros, classificação e pesquisa para identificar avaliadores com experiência específica: +Você pode usar filtros, classificações e pesquisas para identificar revisores com experiência específica: -![Captura de tela da interface de filtros do Airtable com um filtro de experiência de domínio que deve incluir química e áreas técnicas que devem incluir integração contínua](images/airtable.png) +![Captura de tela da interface em inglês de filtros do Airtable com um filtro de experiência de domínio que deve incluir química e áreas técnicas que devem incluir integração contínua](images/airtable.png) -Verifique a avaliação mais recente do avaliador e evite qualquer pessoa que tenha avaliado alguém nos últimos seis meses. -Além disso, verifique se um avaliador iniciante indicou que `require_mentorship`. -Em caso afirmativo, use a parte de orientação do modelo de e-mail e esteja preparado para fornecer orientações adicionais. +Por favor, verifique a avaliação mais recente do revisor(a) e evite qualquer pessoa que tenha avaliado alguém nos últimos seis meses. Além disso, verifique se um revisor(a) iniciante indicou que precisou de mentoria (`require_mentorship`). Nestes casos, use a parte de orientação do modelo de e-mail e esteja preparado para fornecer orientações adicionais. ##### Critérios para escolher um revisor {#criteria-for-choosing-a-reviewer} From bb68754762a5c3a8a581e86ab2818cfcf003af11 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Mon, 2 Dec 2024 09:02:30 +0100 Subject: [PATCH 07/18] R1 chunk 8.2.2.2.3 --- softwarereview_editor.pt.Rmd | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/softwarereview_editor.pt.Rmd b/softwarereview_editor.pt.Rmd index d8d35e51c..f7b909220 100644 --- a/softwarereview_editor.pt.Rmd +++ b/softwarereview_editor.pt.Rmd @@ -82,17 +82,17 @@ Por favor, verifique a avaliação mais recente do revisor(a) e evite qualquer p ##### Critérios para escolher um revisor {#criteria-for-choosing-a-reviewer} -Aqui estão os critérios que você deve ter em mente ao escolher um revisor. Talvez você precise reunir essas informações pesquisando no CRAN e na página do GitHub do possível revisor e na presença on-line em geral (site pessoal, Twitter). +Aqui estão os critérios que você deve ter em mente ao escolher um revisor. Talvez você precise reunir essas informações pesquisando no CRAN e na página do GitHub do possível revisor e em sua presença online em geral (site pessoal, X). -- Você não revisou um pacote para nós nos últimos 6 meses. -- Você tem alguma experiência em desenvolvimento de pacotes. -- Alguma experiência de domínio no campo do pacote ou da fonte de dados -- Não [conflitos de interesse](#coi). +- Revisou um pacote para nós nos últimos 6 meses. +- Tem alguma experiência em desenvolvimento de pacotes. +- Tem alguma experiência de domínio no campo do pacote ou da fonte de dados. +- Não tem [conflitos de interesse](#coi). - Tente equilibrar sua percepção da experiência do possível revisor com a complexidade do pacote. - Diversidade - com dois revisores, ambos não devem ser homens brancos cis. -- Alguma evidência de que você está interessado em abertura ou em atividades da comunidade de R, embora não haja problema em enviar e-mails frios. +- Há evidências de que o possível revisor esteja aberto a opiniões e interessado em atividades da comunidade de R, embora não tenha problema em enviar e-mails frios. -Cada envio deve ser revisado por *dois* revisores de pacotes. Embora seja bom que um deles tenha menos experiência em desenvolvimento de pacotes e mais conhecimento do domínio, a revisão não deve ser dividida em dois. Ambos os revisores precisam revisar o pacote de forma abrangente, embora sob suas perspectivas específicas. Em geral, pelo menos um revisor deve ter experiência prévia em revisão e, é claro, convidar um novo revisor amplia nosso grupo de revisores. +Cada submissão deve ser revisada por *dois* revisores de pacotes. Embora seja aceitável que um deles tenha menos experiência em desenvolvimento de pacotes e mais conhecimento do domínio, a revisão não deve ser dividida em dois. Ambos os revisores precisam revisar o pacote de forma abrangente, embora sob suas perspectivas específicas. Em geral, pelo menos um revisor deve ter experiência prévia em revisão e, é claro, convidar um novo revisor amplia nosso grupo de revisores. ### Durante a revisão: {#during-review} From 01c9d4ea6d5dd1031b52cfd71f36f59cec488df1 Mon Sep 17 00:00:00 2001 From: samuel-carleial Date: Mon, 2 Dec 2024 21:44:36 +0100 Subject: [PATCH 08/18] R1 chunk 8.2.3 --- softwarereview_editor.pt.Rmd | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/softwarereview_editor.pt.Rmd b/softwarereview_editor.pt.Rmd index f7b909220..66863c594 100644 --- a/softwarereview_editor.pt.Rmd +++ b/softwarereview_editor.pt.Rmd @@ -97,13 +97,12 @@ Cada submissão deve ser revisada por *dois* revisores de pacotes. Embora seja a ### Durante a revisão: {#during-review} - Verifique ocasionalmente com os revisores e autores. Ofereça esclarecimentos e ajuda conforme necessário. -- Em geral, procure enviar 3 semanas para revisão, 2 semanas para - alterações subsequentes e uma semana para a aprovação das alterações pelo revisor. +- Em geral, procure calcular 3 semanas para uma revisão, 2 semanas para as alterações subsequentes e 1 semana para a aprovação das alterações pelo revisor. - Após o envio de cada revisão, - - Escreva um comentário agradecendo ao avaliador com suas palavras; - - Registre a avaliação digitando um novo comentário `@ropensci-review-bot submit review time