Skip to content

Commit

Permalink
Merge branch 'main' into softwarereview_editor_management.pt.Rmd-pt-auto
Browse files Browse the repository at this point in the history
  • Loading branch information
yabellini authored Dec 20, 2024
2 parents fa770f1 + a48d630 commit a938ef1
Show file tree
Hide file tree
Showing 23 changed files with 465 additions and 261 deletions.
1 change: 1 addition & 0 deletions .github/workflows/dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ jobs:
env: # Set the secret as an input
AIRTABLE_API_KEY: ${{ secrets.AIRTABLE_API_KEY }}
ZENODO_TOKEN: ${{ secrets.ZENODO_TOKEN }}
BABELQUARTO_CI_URL: https://devdevguide.netlify.app

- name: Move English files
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")'
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ jobs:
env: # Set the secret as an input
AIRTABLE_API_KEY: ${{ secrets.AIRTABLE_API_KEY }}
ZENODO_TOKEN: ${{ secrets.ZENODO_TOKEN }}
BABELQUARTO_CI_URL: ""

- name: Move English files
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")'
Expand Down
344 changes: 173 additions & 171 deletions maintenance_curation.pt.Rmd

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion maintenance_evolution.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ foo_bar(x = 5)
#> Error in foo_bar(x = 5) : use 'y' instead of 'x'
```

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

```r
foo_bar <- function(x, y) {
Expand Down
45 changes: 45 additions & 0 deletions maintenance_github_grooming.pt.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@

# Preparação do GitHub {#grooming}

```{block, type="summaryblock"}
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).
```

## Torne seu repositório mais detectável {#repodiscoverability}

### Tópicos do repositório do GitHub {#git-hub-repo-topics}

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.

Recomendamos:

- Adicionar "r", "r-package" e "rstats" como tópicos ao repositório de seu pacote.

- Adicionar quaisquer outros tópicos relevantes ao repositório do seu pacote.

Poderemos fazer sugestões a você depois que seu pacote for integrado.

### GitHub linguist {#git-hub-linguist}

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".

Recomendamos que você substitua o GitHub linguist adicionando ou modificando um .gitattributes ao seu repositório em dois casos:

- 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))

- 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))

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).

Mais informações sobre as substituições do GitHub linguist podem ser encontradas [aqui](https://github.com/github/linguist#overrides).

## Comercialize sua própria conta {#marketown}

- 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/).

- 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/).

- 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/).


20 changes: 10 additions & 10 deletions maintenance_marketing.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@ aliases:
- marketing.html
---

# Marketing your package {#marketing}
# Marketing do seu pacote {#marketing}

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

- 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.
- 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.

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

- 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).
- 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).

- Tweet about it using the "#rstats" hashtag and tag rOpenSci! This might help with contributor/user engagement. [Example](https://twitter.com/opencpu/status/1003934871830622208).
- 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).

- 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)).
- 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)).

- 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).
- Envie seu pacote para listas de pacotes, como a [Visão de tarefas do CRAN](https://cran.r-project.org/web/views/).

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


4 changes: 2 additions & 2 deletions newstemplate.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
repo-actions: true
---

# NEWS template {#newstemplate}
# Modelo de notícias {#newstemplate}

````markdown
```{r}
#| child: "templates/news.md"
#| child: "templates/news.pt.md"
```
````

11 changes: 3 additions & 8 deletions pkg_building.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -286,15 +286,10 @@ You can make the names of (some) authors clickable by adding their URL, and you

You can make your website content easier to browse by tweaking the navbar, refer to [`pkgdown` documentation](https://pkgdown.r-lib.org/articles/pkgdown.html#navigation-bar). In particular, note that if you name the main vignette of your package "pkg-name.Rmd", it'll be accessible from the navbar as a `Get started` link instead of via `Articles > Vignette Title`.

### Mathjax {#mathjax}
### Math rendering {#mathjax}

Once your package is transferred and it gets a website using our `pkgdown` template, if you want to use Mathjax you'll need to specify it in the `pkgdown` config file like so:

```yaml
template:
params:
mathjax: true
```
Please refer to [pkgdown documentation](https://pkgdown.r-lib.org/dev/articles/customise.html#math-rendering).
Our template is compatible with this configuration.

### Package logo {#package-logo}

Expand Down
11 changes: 3 additions & 8 deletions pkg_building.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -327,15 +327,10 @@ Ver la [documentación de `pkgdown`](https://pkgdown.r-lib.org/reference/build_h
Puedes hacer que el contenido de tu sitio web sea más fácil de navegar modificando la barra de navegación, consulta [`pkgdown` documentación](https://pkgdown.r-lib.org/articles/pkgdown.html#navigation-bar).
En particular, ten en cuenta que si el nombre de la viñeta principal de tu paquete es "pkg-name.Rmd", ésta será accesible desde la barra de navegación en la sección `Para empezar` en vez de en `Artículos > Título de la Viñeta`.

### Mathjax {#mathjax}
### Renderización de matemáticas {#mathjax}

Una vez que tu paquete sea transferido y obtenga un sitio web utilizando nuestra plantilla de `pkgdown`, si quieres utilizar Mathjax tendrás que especificarlo en el archivo de configuración de `pkgdown` de la siguiente manera

```yaml
template:
params:
mathjax: true
```
Lee la [documentación de pkgdown](https://pkgdown.r-lib.org/dev/articles/customise.html#math-rendering).
Nuestra plantilla es compatible con esta configuración.

### Logo del paquete {#package-logo}

Expand Down
8 changes: 4 additions & 4 deletions reviewrequesttemplate.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
repo-actions: true
---

# Review request template {#reviewrequesttemplate}
# Modelo de solicitação de revisão {#reviewrequesttemplate}

Editors may make use of the e-mail template below in recruiting reviewers.
Os editores podem usar o modelo de e-mail abaixo para recrutar revisores.

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

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

Expand All @@ -21,7 +21,7 @@ Editors may make use of the e-mail template below in recruiting reviewers.
::: {.content-visible when-format="pdf"}

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

Expand Down
8 changes: 4 additions & 4 deletions reviewtemplate.pt.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
repo-actions: true
---

# Review template {#reviewtemplate}
# Modelo de revisão {#reviewtemplate}

You can save this as an R Markdown file, or delete the YAML and save it as a Markdown file.
Você pode salvar isso como um arquivo RMarkdown ou excluir o YAML e salvá-lo como um arquivo Markdown.

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

````markdown
```{r}
#| results: 'asis'
#| echo: false
cat(readLines("templates/review.md"), sep = "\n")
cat(readLines("templates/review.pt.md"), sep = "\n")
```
````

Expand All @@ -21,7 +21,7 @@ cat(readLines("templates/review.md"), sep = "\n")
::: {.content-visible when-format="pdf"}

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

:::
Expand Down
10 changes: 2 additions & 8 deletions scripts/airtable-get-reviewers.R
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@

editors <- c(
"Noam Ross", "Karthik Ram", "Maëlle Salmon",
"Anna Krystalli", "Mauro Lepore",
"Laura DeCicco", "Julia Gustavsen",
"Emily Riederer", "Adam Sparks", "Jeff Hollister"
)
reviewers <- airtabler::airtable(base = "app8dssb6a7PG6Vwj",
table = "reviewers-prod")
reviewers <- reviewers$`reviewers-prod`$select_all(fields = list("reviews", "name", "github"))
reviewers <- reviewers$`reviewers-prod`$select_all(fields = list("reviews", "editor", "name", "github"))
editors <- reviewers[lengths(reviewers$editor) > 0,][["name"]]
reviewers <- reviewers[purrr::map_lgl(reviewers$reviews,
~!is.null(.)) &
!(reviewers$name %in% c(editors, "???")), ]
Expand Down
2 changes: 1 addition & 1 deletion softwarereview_author.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ This concise guide presents the software peer review process for you as a packag

- An [editor](#editors) will review your submission within 5 business days and respond with next steps. The editor may assign the package to reviewers, request that the package be updated to meet minimal criteria before review, or reject the package due to lack of fit or overlap.
- If your package meets minimal criteria, the editor will assign 1-3 reviewers. They will be asked to provide reviews as comments on your issue within 3 weeks.
- We ask that you respond to reviewers' comments within 2 weeks of the last-submitted review, but you may make updates to your package or respond at any time. Your response should include a link to the updated [NEWS.md](#news) of your package. Here is [an author response example](https://github.com/ropensci/software-review/issues/160#issuecomment-355043656). We encourage ongoing conversations between authors and reviewers. See the [reviewing guide](#reviewerguide) for more details.
- We ask that you respond to reviewers' comments within 2 weeks of the last-submitted review, but you may make updates to your package or respond at any time. Your response should include a link to the updated [NEWS.md](#news) of your package. Here is [an author response example](https://github.com/ropensci/software-review/issues/160#issuecomment-355043656). Once the response is commited, [submit it using the bot](bot_cheatsheet.html#submit-response-to-reviewers). We encourage ongoing conversations between authors and reviewers. See the [reviewing guide](#reviewerguide) for more details.
- Any time package changes are likely to alter the results of [the automated `pkgcheck` checks](https://docs.ropensci.org/pkgcheck), authors can request a re-check with the command, `@ropensci-review-bot check package`.
- Please notify us immediately if you are no longer able to maintain your package or to respond to reviews. You will then be expected to either retract a submission, or to find alternative package maintainers. You can also discuss maintenance issues in the rOpenSci slack workspace.
- Once your package is approved, we will provide further instructions about the transfer of your repository to the rOpenSci repository.
Expand Down
2 changes: 1 addition & 1 deletion softwarereview_author.es.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Esta guía condensa el proceso de revisión por pares desde el punto de vista de

- Una persona realizará la [edición](#editors) y revisará tu envío en un plazo de 5 días laborables y te responderá con los siguientes pasos a seguir. Puede asignar el paquete a personas para que lo revisen, solicitar que el paquete se actualice para cumplir los criterios mínimos antes de la revisión, o rechazar el paquete porque el mismo no encaja en rOpenSci o porque se solapa con uno ya existente.
- Si tu paquete cumple con los criterios mínimos, se le asignará de 1 a 3 personas para hacer la revisión, a quienes se les pedirá proporcionar revisiones en forma de comentarios sobre tu *issue* en un plazo máximo de 3 semanas.
- Te pedimos que respondas a estos comentarios en un plazo máximo de 2 semanas desde la última revisión presentada, pero puedes actualizar tu paquete o responder en cualquier momento. Tu respuesta debe incluir un enlace a la actualización del archivo [*NEWS.md*](#news) de tu paquete. Aquí tienes [un ejemplo de respuesta](https://github.com/ropensci/software-review/issues/593#issuecomment-1714421144). Fomentamos las conversaciones continuas entre quienes envían el paquete y quienes lo revisan. Consulta la [guía de revisión](#reviewerguide) para más detalles.
- Te pedimos que respondas a estos comentarios en un plazo máximo de 2 semanas desde la última revisión presentada, pero puedes actualizar tu paquete o responder en cualquier momento. Tu respuesta debe incluir un enlace a la actualización del archivo [*NEWS.md*](#news) de tu paquete. Aquí tienes [un ejemplo de respuesta](https://github.com/ropensci/software-review/issues/593#issuecomment-1714421144). Una vez hayas respondido, [enviala a nuestra base de datos usando nuestro bot](/es/bot_cheatsheet.es#submit-response-to-reviewers). Animamos a la continuación de conversaciones entre autores y revisores. Consulta la [guía de revisión](#reviewerguide) para más detalles.
- Si algún cambio en el paquete puede modificar los resultados de [`pkgcheck`](https://docs.ropensci.org/pkgcheck), se puede solicitar un nuevo chequeo con el comando `@ropensci-review-bot check package`.
- Por favor, notifícanos inmediatamente si ya no puedes mantener tu paquete o responder a las revisiones. En ese caso, se espera que retractes el envío o que encuentres responsables alternativos para mantener del paquete. También puedes discutir los problemas de mantenimiento en el Slack de rOpenSci.
- Una vez que tu paquete sea aceptado, te proporcionaremos más instrucciones sobre la transferencia de tu repositorio al repositorio de rOpenSci.
Expand Down
Loading

0 comments on commit a938ef1

Please sign in to comment.