Skip to content

Commit 44d942a

Browse files
committed
2 parents ec01e86 + 40e12d7 commit 44d942a

26 files changed

+673
-253
lines changed

.github/workflows/dev.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ jobs:
3737
env: # Set the secret as an input
3838
AIRTABLE_API_KEY: ${{ secrets.AIRTABLE_API_KEY }}
3939
ZENODO_TOKEN: ${{ secrets.ZENODO_TOKEN }}
40+
BABELQUARTO_CI_URL: https://devdevguide.netlify.app
4041

4142
- name: Move English files
4243
run: Rscript -e 'file.copy(from = "_book/rOpenSci-Packages--Development,-Maintenance,-and-Peer-Review.pdf", to = "_book/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/images")'

.github/workflows/pr.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ jobs:
3939
env: # Set the secret as an input
4040
AIRTABLE_API_KEY: ${{ secrets.AIRTABLE_API_KEY }}
4141
ZENODO_TOKEN: ${{ secrets.ZENODO_TOKEN }}
42+
BABELQUARTO_CI_URL: ""
4243

4344
- name: Move English files
4445
run: Rscript -e 'file.copy(from = "_book/rOpenSci-Packages--Development,-Maintenance,-and-Peer-Review.pdf", to = "_book/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/images")'

booknews.Rmd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# NEWS {#booknews}
22

3+
## dev version
4+
5+
- 2024-09-06, update math guidance for pkgdown based on pkgdown's update (#838)
6+
7+
- 2024-08-30, remove mention of Twitter since rOpenSci no longer maintains an active Twitter account (`@yabellini`, #827)
8+
9+
- 2024-07-17, document dashboard in editors' chapter (`@mpadge`, #829)
10+
11+
- 2024-06-27, document the author's submit response step in the author guide (`@jmaspons`, #832).
12+
313
## 0.9.0
414

515
- 2024-01-09, update roxygen2 wording (`@vincentvanhees`, #792).

maintenance_curation.pt.Rmd

Lines changed: 173 additions & 171 deletions
Large diffs are not rendered by default.

maintenance_evolution.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ foo_bar(x = 5)
3838
#> Error in foo_bar(x = 5) : use 'y' instead of 'x'
3939
```
4040

41-
If you want to be more helpful, you could emit a warning but automatically take the necessary action:
41+
If you want the function to be more helpful, you could change it to emit a warning but automatically take the necessary action:
4242

4343
```r
4444
foo_bar <- function(x, y) {
@@ -226,6 +226,6 @@ An example of a minimal README in an archived package is in [ropensci-archive/mo
226226
- [ ] Archive the repository on GitHub (also under repo settings).
227227
- [ ] Transfer the repository to [ropensci-archive](https://github.com/ropensci-archive), or request an [rOpenSci staff member](https://ropensci.org/about/#team) to transfer it (you can email `[email protected]`).
228228

229-
Archived packages may be unarchived if authors or a new person opt to resume maintenance. For that please contact rOpenSci. They are transferred to the ropenscilabs organization.
229+
Archived packages may be unarchived if authors or a new person opt to resume maintenance. For that please contact rOpenSci.
230230

231231

maintenance_evolution.es.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,6 @@ Una vez que el *README* se ha copiado en otro lugar y se ha reducido a su forma
236236
- [ ] Transfiere el repositorio a [ropensci-archive](https://github.com/ropensci-archive) o solicita a un [miembro del equipo de rOpenSci](https://ropensci.org/about/#team) que lo haga (puedes enviar un correo electrónico a `[email protected]`).
237237

238238
Los paquetes archivados pueden ser desarchivados si quien lo mantenía, o una nueva persona, deciden reanudar el mantenimiento.
239-
Para ello, ponte en contacto con rOpenSci y se transferirá el repo a la organización ropenscilabs.
239+
Para ello, ponte en contacto con rOpenSci.
240240

241241

maintenance_github_grooming.pt.Rmd

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
2+
# Preparação do GitHub {#grooming}
3+
4+
```{block, type="summaryblock"}
5+
Atualmente, os pacotes da rOpenSci são, em sua grande maioria, desenvolvidos no GitHub. Aqui, estão algumas dicas para aproveitar a plataforma em uma seção sobre [tornar seu repositório mais detectável](#repodiscoverability) e uma seção sobre [comercializar sua própria conta do GitHub após passar pela revisão por pares](#marketown).
6+
7+
```
8+
9+
## Torne seu repositório mais detectável {#repodiscoverability}
10+
11+
### Tópicos do repositório do GitHub {#git-hub-repo-topics}
12+
13+
Os [tópicos de repositórios](https://blog.github.com/2017-01-31-introducing-topics/) do GitHub ajudam a navegar e pesquisar repositórios do GitHub, são usados pelo [R-universe em páginas de pacotes e para resultados de pesquisa](https://github.com/r-universe-org/help#how-to-add-keyword-labels-to-an-r-package) e são processados pelo [`codemetar`](https://github.com/ropensci/codemetar) para palavras-chave de registro da rOpenSci.
14+
15+
Recomendamos:
16+
17+
- Adicionar "r", "r-package" e "rstats" como tópicos ao repositório de seu pacote.
18+
19+
- Adicionar quaisquer outros tópicos relevantes ao repositório do seu pacote.
20+
21+
Poderemos fazer sugestões a você depois que seu pacote for integrado.
22+
23+
### GitHub linguist {#git-hub-linguist}
24+
25+
O [GitHub linguist](https://github.com/github/linguist) atribuirá uma linguagem ao seu repositório com base nos arquivos que ele contém. Alguns pacotes que contêm muito código em C++ podem ser classificados como pacotes C++ em vez de pacotes R, o que é bom e mostra a necessidade de adicionar os tópicos "r", "r-package" e "rstats".
26+
27+
Recomendamos que você substitua o GitHub linguist adicionando ou modificando um .gitattributes ao seu repositório em dois casos:
28+
29+
- Se você armazenar arquivos html em locais diferentes do padrão (não em docs/, por exemplo, em vignettes/), use as substituições de documentação. Adicione `*.html linguist-documentation=true` ao arquivo .gitattributes ([Exemplo em uso real](https://github.com/ropensci/ecoengine/blob/56b64d8d29dfae430a776d1dd440b240452eb1bf/.gitattributes#L5))
30+
31+
- Se o seu repositório contiver código que você não criou, por exemplo, código JavaScript, adicione `inst/js/* linguist-vendored` a .gitattributes ([Exemplo em uso real](https://github.com/ropensci/wellknown/blob/4435eb620eeae346d2cab7d62276c29dee29a898/.gitattributes#L1))
32+
33+
Dessa forma, a classificação da linguagem e as estatísticas do seu repositório refletirão melhor o código-fonte que ele contém, além de torná-lo mais detectável. Notavelmente, se o GitHub linguist não reconhecer corretamente que seu repositório contém principalmente código R, seu pacote não aparecerá nos resultados de pesquisa usando o filtro `language:R`. Da mesma forma, seu repositório não poderá ser listado entre os [repositórios R em alta](https://github.com/trending/r).
34+
35+
Mais informações sobre as substituições do GitHub linguist podem ser encontradas [aqui](https://github.com/github/linguist#overrides).
36+
37+
## Comercialize sua própria conta {#marketown}
38+
39+
- Como autor de um pacote integrado, você agora é membro da organização "ropensci" da rOpenSci no GitHub. Por padrão, as participações da organização são privadas; consulte [como torná-la pública na documentação do GitHub](https://help.github.com/articles/publicizing-or-hiding-organization-membership/).
40+
41+
- Mesmo após o repositório do seu pacote ser transferido para a rOpenSci, você pode [fixá-lo em sua conta pessoal](https://help.github.com/articles/pinning-repositories-to-your-profile/).
42+
43+
- Em geral, recomendamos que você adicione pelo menos um avatar (que não precisa ser seu rosto!) e seu nome [no seu perfil do GitHub](https://help.github.com/articles/customizing-your-profile/).
44+
45+

maintenance_marketing.pt.Rmd

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@ aliases:
44
- marketing.html
55
---
66

7-
# Marketing your package {#marketing}
7+
# Marketing do seu pacote {#marketing}
88

99
```{block, type="summaryblock"}
10-
We will help you promoting your package but here are some more things to keep in mind.
10+
Ajudaremos você a promover o seu pacote, mas aqui estão mais algumas coisas que você deve ter em mente.
1111
```
1212

13-
- If you hear of an use case of your package, please encourage its author to post the link to our [discussion forum in the Use Cases category](https://discuss.ropensci.org/c/usecases), [for a tweet from rOpenSci and possible inclusion in the rOpenSci biweekly newsletter](https://discuss.ropensci.org/t/about-the-usecases-category/33). We also recommend you to add a link to the use case in a "use cases in the wild" section of your README.
13+
- Se você souber de um caso de uso de seu pacote, incentive o autor a publicar o link em nosso [fórum de discussão na categoria *Use Cases*](https://discuss.ropensci.org/c/usecases), [para um post no Mastodon da rOpenSci e possível inclusão no boletim quinzenal da rOpenSci](https://discuss.ropensci.org/t/about-the-usecases-category/33). Também recomendamos que você adicione um link para o caso de uso em uma seção "use cases in the wild" do seu README.
1414

15-
- When you [release](#releasing) a new version of your package or release it to CRAN for the first time,
15+
- Quando você [liberar](#releasing) uma nova versão do seu pacote ou você lançá-lo pela primeira vez no CRAN,
1616

17-
- Make a pull request to [R Weekly](https://github.com/rweekly/rweekly.org) with a line about the release under the "New Releases" section (or "New Packages" for the first GitHub/CRAN release).
17+
- Faça um *pull request* para a [R Weekly](https://github.com/rweekly/rweekly.org) com uma linha sobre essa nova versão na seção "New Releases" (ou "New Packages" para a primeira versão do GitHub/CRAN).
1818

19-
- Tweet about it using the "#rstats" hashtag and tag rOpenSci! This might help with contributor/user engagement. [Example](https://twitter.com/opencpu/status/1003934871830622208).
19+
- Tweet sobre isso usando a hashtag "#rstats" e marque rOpenSci! Isso pode ajudar no envolvimento do colaborador/usuário. [Exemplo](https://twitter.com/opencpu/status/1003934871830622208).
2020

21-
- Consider submitting a short post about the release to [rOpenSci tech notes](https://ropensci.org/technotes/). Contact rOpenSci Community Manager, (e.g. via Slack or [[email protected]](mailto:[email protected])). Refer to [the guidelines about contributing a blog post](https://blogguide.ropensci.org)).
21+
- Considere a possibilidade de enviar um breve post sobre o lançamento para as [Notas técnicas da rOpenSci](https://ropensci.org/technotes/). Entre em contato com o/a gerente da comunidade do rOpenSci (por exemplo, via Slack ou [[email protected]](mailto:[email protected])). Consulte [as diretrizes sobre como contribuir com um *blog post*](https://blogguide.ropensci.org)).
2222

23-
- Submit your package to lists of packages such as [CRAN Task Views](https://cran.r-project.org/web/views/), and [rOpenSci non-CRAN Task Views](https://github.com/search?utf8=%E2%9C%93&q=user%3Aropensci+%22task+view%22&type=Repositories&ref=searchresults).
23+
- Envie seu pacote para listas de pacotes, como a [Visão de tarefas do CRAN](https://cran.r-project.org/web/views/).
2424

25-
- If you choose to market your package by giving a talk about it at a meetup or conference (excellent idea!)
26-
read [this article of Jenny Bryan's and Mara Averick's](https://www.tidyverse.org/articles/2018/07/carpe-talk/).
25+
- Se você optar por divulgar o seu pacote dando uma palestra sobre ele em um encontro ou conferência (excelente ideia!)
26+
leia [este artigo de Jenny Bryan e Mara Averick](https://www.tidyverse.org/articles/2018/07/carpe-talk/).
2727

2828

newstemplate.pt.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
repo-actions: true
33
---
44

5-
# NEWS template {#newstemplate}
5+
# Modelo de notícias {#newstemplate}
66

77
````markdown
88
```{r}
9-
#| child: "templates/news.md"
9+
#| child: "templates/news.pt.md"
1010
```
1111
````
1212

preface.Rmd

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,6 @@ This book is a living document.
2020
You can view updates to our best practices and policies via the [release notes](#booknews).
2121
You can cite this book using [its Zenodo metadata and DOI](https://doi.org/10.5281/zenodo.2553043).
2222

23-
```{r}
24-
#| echo: false
25-
#| results: 'asis'
26-
#| warning: false
27-
source(file.path("scripts", "airtable-get-reviewers.R"), local = knitr::knit_global())
28-
```
29-
3023
_If you want to contribute to this book (suggestions, corrections) please refer to [the GitHub repository](https://github.com/ropensci/dev_guide) in particular [the contributing guidelines](https://github.com/ropensci/dev_guide#contributing). Thanks!_
3124

3225
_We are thankful for all authors, reviewers and guest editors for helping us improve the system and this guide over the years. Thanks also to the following persons who made contributions to this guide and its previous incarnations: `r readLines("thanks.md")` Please tell us if we forgot to acknowledge your contribution!_

0 commit comments

Comments
 (0)