Skip to content

Add PT-BR automatic translation softwarereview_intro.pt.Rmd #822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
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
86 changes: 86 additions & 0 deletions softwarereview_intro.pt.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Revisão por pares de software, por quê? O que é? {#softwarereviewintro}

```{block, type="summaryblock"}
Este capítulo contém uma [introdução geral](#whatissoftwarereview) ao nosso sistema de revisão por pares de software para pacotes, [razões para submeter um pacote](#whysubmit), [razões para se voluntariar como revisor(a)](#whyreview), [por que nossas revisões são abertas](#whyopen) e agradecimentos às pessoas [que participam do sistema de revisão](#editors-and-reviewers).

Nosso sistema foi recentemente ampliado para [revisão por pares de software estatístico](https://ropensci.org/stat-software-review/).

_Se você usar nossos padrões/checklists/etc ao revisar um software em outro lugar, informe aos destinatários (por exemplo, editores(as) 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/).
```

## O que é a revisão de software por pares da rOpenSci? {#whatissoftwarereview}

A [coleção de pacotes](https://ropensci.org/packages/) da rOpenSci é parcialmente resultado de contribuições de membros(as) da equipe e parcialmente constituída por membros(as) da comunidade, o que significa que a coleção provém de uma grande diversidade de habilidades e de experiência de pessoas desenvolvedoras. Como garantir a qualidade de todo a coleção? É aí que entra a revisão por pares de software: os pacotes contribuídos pela comunidade passam por um processo de revisão transparente, construtivo, não adversarial e aberto. Para esse processo, que depende principalmente de trabalho voluntário, os(as) [editores(as) associados(as)](#associateditors) gerenciam o fluxo de submissões e garantem o andamento dos envios; os autores(as) criam, submetem e aprimoram seus pacotes; os [revisores(as)](#reviewers), duas pessoas por submissão, examinam o código e a experiência do usuário. [Esta publicação no blog](https://www.numfocus.org/blog/how-ropensci-uses-code-review-to-promote-reproducible-science/) escrito por editores(as) da rOpenSci é uma boa introdução à revisão por pares de software da rOpenSci. Outros posts sobre a própria revisão e sobre pacotes revisados podem ser encontrados [através da tag "software-peer-review" no blog da rOpenSci](https://ropensci.org/tags/software-peer-review/).

Você pode reconhecer os pacotes do rOpenSci que foram revisados por pares por meio de um emblema verde "peer-reviewed" em seu README, com links para suas revisões (cf [este exemplo](https://github.com/ropensci/restez#locally-query-genbank-)); e por meio de um ícone de comentário azul próximo à sua descrição em [página de pacotes do rOpenSci](https://ropensci.org/packages/) com links para as revisões.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

About the part "ícone de comentário azul próximo à sua descrição":
It was quite difficult to understand what it meant in the translation.
I looked up on the website and this is an attempt to describe it a bit better.
But this is a small change from the source book, I'm not sure how to proceed.

Suggested change
Você pode reconhecer os pacotes do rOpenSci que foram revisados por pares por meio de um emblema verde "peer-reviewed" em seu README, com links para suas revisões (cf [este exemplo](https://github.com/ropensci/restez#locally-query-genbank-)); e por meio de um ícone de comentário azul próximo à sua descrição em [página de pacotes do rOpenSci](https://ropensci.org/packages/) com links para as revisões.
Você pode reconhecer os pacotes da rOpenSci que foram revisados por pares por meio de um selo (*badge*) verde com o texto "peer-reviewed" em seu README, com links para suas revisões ([por exemplo](https://github.com/ropensci/restez#locally-query-genbank-)); e por meio de um botão azul com o texto *"Peer-reviewed"* próximo à sua descrição na [página de pacotes da rOpenSci](https://ropensci.org/packages/) com links para as revisões.


Tecnicamente, aproveitamos ao máximo o [GitHub](https://github.com/): cada processo de revisão de pacote é uma *issue* no [repositório `ropensci/software-review` no GitHub](https://github.com/ropensci/software-review/). Por exemplo, clique [aqui](https://github.com/ropensci/software-review/issues/24) para ler o tópico de revisão do pacote `ropenaq`: o processo é uma conversa contínua até a aceitação do pacote, com duas revisões externas como marcos importantes. Além disso, usamos os recursos do GitHub, como o uso de *issue templates* (como templates de submissão) e uso de *labels* (etiquetas) que usamos para acompanhar o progresso dos envios (desde as verificações do(a) editor(a) até a aprovação).

## Por que enviar seu pacote para a rOpenSci? {#whysubmit}

- Em primeiro lugar, e acima de tudo, esperamos que você envie seu pacote para análise **porque você valoriza o feedback**. Nosso objetivo é fornecer feedbacks úteis para os(as) autores(as) de pacotes e fazer com que nosso processo de revisão seja aberto, não contraditório e focado na melhoria da qualidade do software.
- Ao fazer parte da coleção de pacotes da rOpenSci, seu pacote continuará a receber **suporte da equipe da rOpenSci**. Você manterá a propriedade e o controle do seu pacote, mas podemos ajudar com questões de manutenção contínua, como as associadas a atualizações do R, dependências e políticas do CRAN.
- A rOpenSci irá **divulgar seu pacote** através da nossa [página web](https://ropensci.org/packages/), [blog](https://ropensci.org/blog/) e mídias sociais (como [Mastodon](https://fosstodon.org/@ropensci) e [LinkedIn](https://www.linkedin.com/company/ropensci/)). Os pacotes em nossa coleção também recebem um [site de documentação que é renderizado e publicado automaticamente após cada envio](#docsropensci).
- Os pacotes da rOpenSci **podem ser incluídos em uma lista cruzada** com outros repositórios, como o CRAN e o BioConductor.
- Os pacotes da rOpenSci que estão no escopo do [Journal of Open-Source Software](https://joss.theoj.org/) e que tenham um artigo curto relacionado, poderão, a critério dos editores do JOSS, beneficiar-se de um processo de revisão acelerado (*fast-track*).
- Se você escrever um, a rOpenSci irá **divulgar os livros relacionado ao seu pacote**: você pode transferir o código-fonte de tais livros para [a organização `ropensci-books` no GitHub](https://github.com/ropensci-books) para que os livros sejam listados em [books.ropensci.org](https://books.ropensci.org/).

## Por que revisar pacotes para o rOpenSci? {#whyreview}

- Como em qualquer processo de revisão por pares, esperamos que você opte por revisar **para que você retribua à rOpenSci e às comunidades científicas.** Nossa missão de expandir o acesso a dados científicos e promover uma cultura de pesquisa reprodutível só é possível por meio dos esforços voluntários de membros(as) da comunidade como você.
- A revisão é uma conversa de mão dupla. Ao revisar os pacotes, você terá a chance de **continuar aprendendo práticas de desenvolvimento com os(as) autores(as) e outros(as) revisores(as)**.
- A natureza aberta do nosso processo de revisão permite que você **faça contatos e conheça colegas e colaboradores(as)** durante o processo de revisão. Nossa comunidade é acolhedora e composta por pessoas prestativas, especialistas em desenvolvimento em R e em diversas outras áreas da ciência e da computação científica.
- Para se voluntariar para ser um(a) de nossos(as) revisores(as), preencha [este breve formulário](https://airtable.com/shrnfDI2S9uuyxtDw) fornecendo suas informações de contato e áreas de especialização. Estamos sempre procurando mais revisores(as) com experiência geral em desenvolvimento de pacotes e com conhecimento especializado nas áreas em que os pacotes são usados.

## Por que as avaliações são abertas? {#whyopen}

Nossos tópicos (*issues*) de revisão são públicos. As pessoas autoras, revisoras e editoras conhecem as identidades umas das outras. A comunidade mais ampla pode visualizar ou até participar da conversa conforme ela acontece. Isso incentiva a atenção aos detalhes e o fornecimento de avaliações construtivas e não adversariais. Tanto autores(as) quanto [revisores(as) relatam](https://ropensci.org/tags/reviewer/) que apreciam e aprendem mais com essa troca aberta e direta. Também traz o benefício de fortalecer a comunidade. Participantes têm a oportunidade de estabelecer conexões significativas com colegas, e novas colaborações surgiram a partir de ideias geradas durante o processo de revisão.

Estamos cientes de que sistemas abertos podem ter desvantagens. Por exemplo, na revisão acadêmica tradicional, [a revisão por pares duplo-cega pode aumentar a representação de autoras do gênero feminino](https://www.sciencedirect.com/science/article/pii/S0169534707002704), sugerindo viés em revisões não-cegas. Também é possível que revisores(as) sejam menos críticos em revisões abertas. No entanto, sustentamos que a abertura da conversa de revisão funciona como um controle de qualidade e viés; é mais difícil inserir comentários subjetivos ou sem embasamento em público e sem o manto do anonimato. Em última análise, acreditamos que a comunicação direta e pública entre autores(as) e revisores(as) melhora a qualidade e a equidade das revisões.

Além disso, os(as) autores(as) e revisores(as) podem entrar em contato com os(as) editores(as) em particular se tiverem alguma dúvida ou questão.

## Como os usuários saberão que um pacote foi revisado? {#how-will-users-know-a-package-has-been-reviewed}

- O README do seu pacote apresentará um selo de revisão por pares com um link para o tópico de revisão do software.
- Seu pacote terá um [site de documentação em `docs.ropensci.org`](#rodocsci) que você pode referenciar no DESCRIPTION.
- Se você quiser, o repositório do seu pacote poderá ser transferido para a organização rOpenSci no GitHub.
- Se os revisores [concordarem em ser listados na DESCRIÇÃO](#authorship) seus metadados mencionarão a revisão.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase is not 100% clear to me.
In "their metadata will mention the review.", "their metadata" is referring to the package metadata?
If so, we can make if more explicit:

Suggested change
- Se os revisores [concordarem em ser listados na DESCRIÇÃO](#authorship) seus metadados mencionarão a revisão.
- Se os(as) revisores(as) [concordarem em ser listados(as) no DESCRIPTION](#authorship), os metadados do pacote mencionarão a revisão.


## Editores e revisores {#editors-and-reviewers}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is quite different because the file in English has been updated since the begining of the translation process:
https://github.com/ropensci/dev_guide/blob/main/softwarereview_intro.Rmd

Suggested change
## Editores e revisores {#editors-and-reviewers}
## Editores(as) e revisores(as) {#editors-and-reviewers}
O processo de revisão por pares de software da rOpenSci é conduzido pela nossa equipe dedicada de editores(as) e revisore(as). Informações sobre a equipe atual e o andamento da revisão por pares de software podem ser consultadas em nosso [painel interativo](https://ropensci-review-tools.github.io/dashboard/).
```{r}
#| echo: false
#| results: 'asis'
#| warning: false
if (nzchar(Sys.getenv("AIRTABLE_API_KEY"))) {
source(file.path("scripts", "airtable-get-data.R"), local = knitr::knit_global())
}
```
### Editoria-Chefe
```{r}
#| echo: false
#| results: 'asis'
if (nzchar(Sys.getenv("AIRTABLE_API_KEY"))) {
source(file.path("scripts", "airtable-get-eic.R"), local = knitr::knit_global())
} else {
cat("_No Airtable data available._")
}
```


### Editores associados {#associateditors}

O processo de revisão por pares de software da rOpenSci é conduzido por:

```{r}
#| child: "associate-editors.md"
```
Comment on lines +52 to +58
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is quite different because the file in English has been updated since the begining of the translation process:
https://github.com/ropensci/dev_guide/blob/main/softwarereview_intro.Rmd

Suggested change
### Editores associados {#associateditors}
O processo de revisão por pares de software da rOpenSci é conduzido por:
```{r}
#| child: "associate-editors.md"
```
### Equipe editorial
Nossa equipe atual de editores(as) para revisão por pares de software inclui:
```{r}
#| echo: false
#| results: 'asis'
if (nzchar(Sys.getenv("AIRTABLE_API_KEY"))) {
source(file.path("scripts", "airtable-get-editors.R"), local = knitr::knit_global())
} else {
cat("_No Airtable data available._")
}
```


### Revisores {#reviewers}

Somos gratos às seguintes pessoas que ofereceram seu tempo e conhecimento para revisar os pacotes enviados à rOpenSci.

```{r}
#| echo: false
source(file.path("scripts", "airtable-access.R"), local = knitr::knit_global())
```

```{r}
#| echo: false
#| results: 'asis'
#| eval: !expr has_airtable_access()
source(file.path("scripts", "airtable-get-reviewers.R"), local = knitr::knit_global())
```

Também somos gratos às seguintes pessoas que atuaram como editores convidados.

```{r}
#| echo: false
#| results: 'asis'
#| eval: !expr has_airtable_access()
source(file.path("scripts", "airtable-get-editors.R"), local = knitr::knit_global())

```
Comment on lines +60 to +84
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is quite different because the file in English has been updated since the begining of the translation process:
https://github.com/ropensci/dev_guide/blob/main/softwarereview_intro.Rmd

Suggested change
### Revisores {#reviewers}
Somos gratos às seguintes pessoas que ofereceram seu tempo e conhecimento para revisar os pacotes enviados à rOpenSci.
```{r}
#| echo: false
source(file.path("scripts", "airtable-access.R"), local = knitr::knit_global())
```
```{r}
#| echo: false
#| results: 'asis'
#| eval: !expr has_airtable_access()
source(file.path("scripts", "airtable-get-reviewers.R"), local = knitr::knit_global())
```
Também somos gratos às seguintes pessoas que atuaram como editores convidados.
```{r}
#| echo: false
#| results: 'asis'
#| eval: !expr has_airtable_access()
source(file.path("scripts", "airtable-get-editors.R"), local = knitr::knit_global())
```
### Revisores(as) e editores(as) passados(as)
Agradecemos as seguintes pessoas que dedicaram seu tempo e conhecimento para revisar pacotes submetidos à rOpenSci.
```{r}
#| echo: false
#| results: 'asis'
if (nzchar(Sys.getenv("AIRTABLE_API_KEY"))) {
source(file.path("scripts", "airtable-get-reviewers.R"), local = knitr::knit_global())
} else {
cat("_No Airtable data available._")
}
```
Também agradecemos aos seguintes editores(as) que atuaram anteriormente.
```{r editors_past, echo=FALSE, results='asis'}
if (nzchar(Sys.getenv("AIRTABLE_API_KEY"))) {
cat(gen_ed_out(editors_past), sep = "")
} else {
cat("_No Airtable data available._")
}
```
E aos(as) seguintes que atuaram como editores(as) convidados(as).
```{r guest-editors-out, echo=FALSE, results='asis'}
if (nzchar(Sys.getenv("AIRTABLE_API_KEY"))) {
cat(gen_ed_out(guest_editors), sep = "")
} else {
cat("_No Airtable data available._")
}
```



Loading