Skip to content

Commit

Permalink
Merge branch 'main' into bookreleaseissue-pt
Browse files Browse the repository at this point in the history
  • Loading branch information
yabellini authored Dec 14, 2023
2 parents cfeaad7 + 623cca6 commit 18b2c70
Show file tree
Hide file tree
Showing 27 changed files with 627 additions and 56 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Package: rOpenScidevguide
Package: ropenscidevguide
Type: Website
Title: rOpenSci Packages: Development, Maintenance, and Peer Review
Description: rOpenSci Packages: Development, Maintenance, and Peer Review
Expand Down
15 changes: 10 additions & 5 deletions R/translate.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
translate_page <- function(page_path) {
git_branch_name <- sprintf("%s-es-auto", page_path)
translate_page <- function(page_path, language, glossary = NULL) {
git_branch_name <- sprintf(
"%s-%s-auto",
page_path,
tolower(strsplit(language, "-")[[1]][[1]])
)

gert::git_branch_checkout("main")
gert::git_pull()
Expand All @@ -9,17 +13,18 @@ translate_page <- function(page_path) {
gert::git_branch_checkout(git_branch_name)
}
withr::local_envvar("DEEPL_API_URL" = "https://api.deepl.com")
withr::local_envvar("DEEPL_API_KEY" = keyring::key_get("deepl"))
babeldown::deepl_translate(
path = page_path,
out_path = page_path,
glossary = "glosario",
glossary = glossary,
source_lang = "EN",
target_lang = "ES",
target_lang = language,
formality = "less"
)

gert::git_add(page_path)
gert::git_commit(sprintf("Add Spanish automatic translation %s", page_path))
gert::git_commit(sprintf("Add %s automatic translation %s", language, page_path))
gert::git_push()
usethis::pr_init(git_branch_name)
usethis::pr_push()
Expand Down
6 changes: 3 additions & 3 deletions approval2template.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
repo-actions: true
---

# Reviewer approval comment template {#approval2template}
# Modelo de comentário de aprovação do(a) revisor(a) {#approval2template}

::: {.content-hidden when-format="pdf"}

````markdown
```{r}
#| results: 'asis'
#| echo: false
#| child: "templates/reviewer-approval.md"
#| child: "templates/reviewer-approval.pt.md"
```
````

Expand All @@ -19,7 +19,7 @@ repo-actions: true
::: {.content-visible when-format="pdf"}

```{r}
#| child: "templates/reviewer-approval.md"
#| child: "templates/reviewer-approval.pt.md"
```

Expand Down
6 changes: 6 additions & 0 deletions booknews.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

## dev (0.9.0)

- 2023-09-15, add suggestions for API packages (#496).

- Translation to Spanish!

- 2023-07-17, Update Aims and Scope to include translation packages, remove experimental text-processing categories, and provide clarifications around API wrappers

- 2023-05-04, Added link to Bioconductor book (#663, `@llrs`).

- 2023-04-26, Changed suggested lifecycle stage in authors guide (#661, `@bart1`).
Expand Down
158 changes: 158 additions & 0 deletions bot_cheatsheet.pt.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
# Comandos do bot {#bot-commands}

## Para todos {#for-everyone}

Vale ressaltar que nós limpamos os tópicos de problemas ao remover todo conteúdo estranho, portanto, o registro de que você solicitou ajuda de bots será rapidamente apagado ou ocultado.

### Veja a lista de comandos disponíveis para você {#see-the-list-of-commands-available-to-you}

Se você precisar de um lembrete rápido!

```markdown
@ropensci-review-bot help
```

### Veja o código de conduta {#see-the-code-of-conduct}

```markdown
@ropensci-review-bot code of conduct
```


## Para autores {#for-authors}

### Verificar o pacote com o pkgcheck {#check-package-with-pkgcheck}

Quando seu pacote tiver mudado substancialmente.

```markdown
@ropensci-review-bot check package
```

### Enviar resposta aos revisores {#submit-response-to-reviewers}

Para registrar sua resposta aos revisores.

```markdown
@ropensci-review-bot submit response <response-url>
```

onde `<response_url>` é o link para o comentário de resposta no tópico do problema.

### Finalizar a transferência do repositório {#finalize-repo-transfer}

Depois que você aceitar o convite para a organização do GitHub do rOpenSci e transferir seu repositório do GitHub para ela, execute este comando para obter novamente o acesso de administrador ao seu repositório.

```markdown
@ropensci-review-bot finalize transfer of <package-name>
```

### Obter um novo convite após a aprovação {#get-a-new-invite-after-approval}

Se você perdeu o prazo de uma semana para aceitar o convite para a organização do rOpenSci no GitHub, execute isso para receber um novo convite.

```markdown
@ropensci-review-bot invite me to ropensci/<package-name>
```

## Para o editor-chefe {#for-the-editor-in-chief}

### Atribua um (a) editor (a) {#assign-an-editor}

```markdown
@ropensci-review-bot assign @username as editor
```

### Colocar o envio em espera {#put-submission-on-hold}

Veja [política editorial](#policiesreviewprocess).

```markdown
@ropensci-review-bot put on hold
```

### Indique que o envio está fora do escopo {#indicate-the-submission-is-out-of-scope}

Não se esqueça de publicar primeiro um comentário explicando a decisão e agradecendo ao(s) autor(es) pelo envio.

```markdown
@ropensci-review-bot out-of-scope
```

## Para o editor designado {#for-assigned-editor}

### Colocar o envio em espera {#put-submission-on-hold}

Veja [política editorial](#policiesreviewprocess).

```markdown
@ropensci-review-bot put on hold
```

### Verificar o pacote com o pkgcheck {#check-package-with-pkgcheck}

Geralmente, apenas em consultas pré-submissão ou quando os autores indicam que o pacote foi substancialmente alterado.

```markdown
@ropensci-review-bot check package
```

### Verificar padrões estatísticos {#check-statistical-standards}

Geralmente, apenas em consultas pré-submissão ou quando os autores indicam que o pacote foi substancialmente alterado.

```markdown
@ropensci-review-bot check srr
```

### Verifique se o README tem o selo de revisão de software {#check-that-readme-has-software-review-badge}

No final do processo de envio.

```markdown
@ropensci-review-bot check readme
```

### Indique que você está procurando revisores {#indicate-you-are-now-seeking-reviewers}

```markdown
@ropensci-review-bot seeking reviewers
```

### Atribuir um (a) revisor (a) {#assign-a-reviewer}

```markdown
@ropensci-review-bot assign @username as reviewer
```

ou

```markdown
@ropensci-review-bot add @username as reviewer
```

### Remover um (a) revisor (a) {#remove-a-reviewer}

```markdown
@ropensci-review-bot remove @username from reviewers
```

### Ajustar a data de vencimento da revisão {#tweak-review-due-date}

```markdown
@ropensci-review-bot set due date for @username to YYYY-MM-DD
```

### Registre que uma revisão foi enviada {#record-that-a-review-was-submitted}

```markdown
@ropensci-review-bot submit review <review-url> time <time in hours>
```

### Aprovar o pacote {#approve-package}

```markdown
@ropensci-review-bot approve <package-name>
```


28 changes: 28 additions & 0 deletions editortemplate.pt.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
repo-actions: true
---

# Editor's template {#editortemplate}

::: {.content-hidden when-format="pdf"}

````markdown
```{r}
#| results: 'asis'
#| echo: false
#| child: "templates/editor.md"
```
````

:::

::: {.content-visible when-format="pdf"}

```{r}
#| child: "templates/editor.md"
```

:::


3 changes: 2 additions & 1 deletion index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@
#| echo: false
#| results: 'asis'
#| warning: false
#| eval: fase
cat("\n```bibtex\n")
u <- "https://zenodo.org/record/2553043" # universal URL redirects to latest
s <- rvest::session(u)
u <- paste0(s$url, "/export/hx") # redirected
u <- paste0(s$url, "/export/bibtex") # redirected
out <- rvest::read_html(u)
bibentry <- rvest::html_text(rvest::html_element(out, "pre"))
cat(bibentry)
Expand Down
1 change: 1 addition & 0 deletions index.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@


```{r}
#| eval: fase
#| echo: false
#| results: 'asis'
#| warning: false
Expand Down
1 change: 1 addition & 0 deletions index.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/3.0/us/"><img alt="Licença Creative Commons" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/us/88x31.png" /></a><br /> Este trabalho está licenciado com uma licença [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States License](https://creativecommons.org/licenses/by-nc-sa/3.0/us/). Utilize o [Zenodo DOI](https://doi.org/10.5281/zenodo.2553043) para citar esta obra.

```{r}
#| eval: fase
#| echo: false
#| results: 'asis'
#| warning: false
Expand Down
66 changes: 66 additions & 0 deletions maintenance_changing_maintainers.pt.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
aliases:
- changing-maintainers.html
---

# Mudando os(as) mantenedores(as) de um pacote {#changing-maintainers}

```{block, type="summaryblock"}
Este capítulo apresenta um guia sobre como assumir a manutenção de um pacote.
```

## Você quer desistir da manutenção do seu pacote? {#do-you-want-to-give-up-maintenance-of-your-package}

Temos uma seção em nosso boletim informativo para chamadas de novos(as) colaboradores(as) que é publicado a cada duas semanas. A seção se chama *Chamada para colaboradores*. Nessa seção, destacamos os pacotes que estão à procura de novos(as) mantenedores(as). Se você deseja desistir da função de mantenedor(a) do seu pacote, entre em contato conosco e poderemos destacar o seu pacote em nosso boletim informativo. Tivemos muito sucesso até o momento, ao encontrarmos novos(as) mantenedores(as) para seis dos seis pacotes anunciados.

## Você quer assumir a manutenção de um pacote? {#do-you-want-to-take-over-maintenance-of-a-package}

Temos uma seção em nosso boletim informativo para chamadas de novos(as) colaboradores(as) que é publicado a cada duas semanas. A seção se chama *Chamada para colaboradores*. Nessa seção, destacamos os pacotes que estão à procura de novos(as) mantenedores(as). Se você ainda não está inscrito no boletim informativo, é uma boa ideia [assinar](https://news.ropensci.org/) para que você seja notificado quando houver um pacote procurando por um novo(a) mantenedor(a).

## Assumir a manutenção de um pacote {#taking-over-maintenance-of-a-package}

- Adicione você como o(a) novo(a) mantenedor(a) no arquivo DESCRIPTION, com `role = c("aut", "cre")`, e, altere o(a) antigo(a) mantenedor(a) para o papel `aut` apenas;
- Certifique-se de alterar o(a) mantenedor(a) para o seu nome em qualquer outro lugar do pacote, mantendo o(a) antigo(a) mantenedor(a) como autor (por exemplo, em manuais do pacote, CONTRIBUTING.md, CITATION etc.);
- Os [Guia de Colaboração](#collaboration) tem orientações sobre como adicionar novos(as) mantenedores(as) e colaboradores(as);
- Pacotes que foram arquivados ou [órfãos][orphaned] no CRAN não precisam da permissão do(a) mantenedor(a) anterior para serem retomados no CRAN. Nesses casos, entre em contato conosco para que possamos oferecer a ajuda necessária;
- Se o pacote não tiver sido arquivado pelo CRAN e houver uma mudança de mantenedor(a), peça ao(à) mantenedor(a) antigo(a) que envie um e-mail ao CRAN e informe por escrito quem é o(a) novo(a) mantenedor(a). Certifique-se de mencionar esse e-mail sobre a mudança de mantenedor(a) quando você enviar a primeira nova versão ao CRAN. Se o(a) antigo(a) mantenedor(a) estiver inacessível ou não enviar esse e-mail, entre em contato com a equipe do rOpenSci;
- Se o(a) mantenedor(a) anterior estiver acessível, agendar uma reunião ajudará você a conhecer melhor a situação atual do pacote;

### Perguntas frequentes para novos(as) mantenedores(as) {#faq-for-new-maintainers}

- Existem alguns problemas no pacote que ainda não foram resolvidos, e que eu não sei como corrigir. A quem posso pedir ajuda?

Depende; aqui está o que você deve fazer em diferentes cenários:

- Se for possível entrar em contato com o(a) antigo(a) mantenedor(a): entre em contato com ele(a) e peça ajuda;
- Slack do rOpenSci: bom para obter ajuda em problemas específicos ou gerais, consulte o canal #package-maintenance;
- [Fórum de discussão do rOpenSci](https://discuss.ropensci.org/c/package-development/29) este forum é uma boa opção, sinta-se à vontade para fazer perguntas;
- [Equipe do rOpenSci](https://ropensci.org/about/#team) sinta-se livre para entrar em contato com um de nós, seja por e-mail ou nos marcando em um problema no GitHub, ficaremos felizes em ajudar;
- é claro, também existem vários centros de ajuda geral sobre o R, se isso atender às suas necessidades: Fórum da comunidade RStudio, StackOverflow, Twitter #rstats, etc.

- O quanto você pode/deve alterar no pacote?

Para obter ajuda geral sobre como alterar o código em um pacote, consulte a seção [Evolução do pacote](#evolution)
de pacotes.

Quando você pensa nisso, há muitas considerações a se fazer.

Quanto tempo você tem para dedicar ao pacote? Se você tiver um tempo muito limitado, seria melhor se concentrar nas tarefas mais importantes, sejam elas quais forem para o pacote em questão. Se você tiver bastante tempo, suas metas poderão ter um escopo maior.

Qual é o grau de maturidade do pacote? Se o pacote for maduro, muitas pessoas provavelmente têm códigos que dependem da API do pacote (ou seja, as funções exportadas e seus parâmetros). Além disso, se houver outros pacotes que dependam do seu pacote no CRAN, você precisa verificar se as suas alterações vão quebrar ou não esses outros pacotes. Quanto mais maduro for o pacote, mais cuidadoso(a) você precisará ser ao fazer alterações, especialmente com os nomes das funções exportadas, seus parâmetros e a estrutura exata do que as funções exportadas retornam. É mais fácil fazer alterações que afetem apenas os aspectos internos do pacote.

## Tarefas da equipe do rOpenSci {#tasks-for-ropensci-staff}

Como organização, a rOpenSci está interessada em garantir que os pacotes de nossa suíte estejam disponíveis enquanto forem úteis para a comunidade. Como os(as) mantenedores(as) precisam seguir em frente, na maioria dos casos tentaremos conseguir um(a) novo(a) mantenedor(a) para cada pacote. Para isso, as tarefas a seguir são de responsabilidade da equipe da rOpenSci.

- Se um repositório não tiver nenhuma atividade (commits, issues, pull requests) há muito tempo, ele pode ser simplesmente um pacote maduro com pouca necessidade de alterações/etc., portanto, leve isso em consideração.
- O(a) mantenedor(a) atual não responde a problemas/solicitações pull há muitos meses, por meio de e-mails, problemas no GitHub ou mensagens no Slack:
- Entre em contato e veja qual é a situação. Ele(a) pode dizer que gostaria de deixar o cargo de mantenedor(a) e, nesse caso, procure um(a) novo(a) mantenedor(a)
- O(a) mantenedor(a) atual está completamente ausente/não está respondendo
- Se isso acontecer, tentaremos entrar em contato com o(a) mantenedor(a) por até um mês. No entanto, se a atualização do pacote for urgente, poderemos usar nosso acesso de administrador para fazer alterações em seu nome.
- Faça uma chamada na seção "Call for Contributors" do boletim informativo da rOpenSci para um(a) novo(a) mantenedor(a) - abra um problema no [repositório do boletim informativo](https://github.com/ropensci/monthly/).

[orphaned]: https://cran.r-project.org/src/contrib/Orphaned/README



Loading

0 comments on commit 18b2c70

Please sign in to comment.