Skip to content

Commit 17beff2

Browse files
authored
Merge pull request #980 from ropensci/cn
rm codemeta req
2 parents fb89c8e + 1cc42d8 commit 17beff2

File tree

7 files changed

+5
-16
lines changed

7 files changed

+5
-16
lines changed

booknews.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## dev version
44

5+
- 2025-12-15, remove codemeta.json requirement (#968).
6+
57
- 2025-10-17, clarify the use of Rd tags for internal functions (#918, `@cforgaci`).
68

79
- 2025-10-09, add translation of the last chapter to Portuguese!

maintenance_github_grooming.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ rOpenSci packages are currently in their vast majority developed on GitHub. Here
1414

1515
### GitHub repo topics {#git-hub-repo-topics}
1616

17-
GitHub [repo topics](https://blog.github.com/2017-01-31-introducing-topics/) help browsing and searching GitHub repos, are used by [R-universe on package pages and for search results](https://docs.r-universe.dev/publish/metadata.html#keywords), and are digested by [`codemetar`](https://github.com/ropensci/codemetar) for rOpenSci registry keywords.
17+
GitHub [repo topics](https://blog.github.com/2017-01-31-introducing-topics/) help browsing and searching GitHub repos, are used by [R-universe on package pages and for search results](https://docs.r-universe.dev/publish/metadata.html#keywords).
1818

1919
We recommend:
2020

maintenance_github_grooming.es.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Aquí tienes algunos consejos para aprovechar la plataforma en una sección sobr
99

1010
### Áreas de repositorio en GitHub {#git-hub-repo-topics}
1111

12-
Las [áreas del repositorio](https://blog.github.com/2017-01-31-introducing-topics/) de GitHub ayudan a navegar y buscar en los repositorios de GitHub, son usadas por [R-universe en paginas de paquetes y para resultados de busquedas](https://docs.r-universe.dev/publish/metadata.html#keywords). También son usadas por [`codemetar`](https://github.com/ropensci/codemetar) en las palabras clave del registro de rOpenSci.
12+
Las [áreas del repositorio](https://blog.github.com/2017-01-31-introducing-topics/) de GitHub ayudan a navegar y buscar en los repositorios de GitHub, son usadas por [R-universe en paginas de paquetes y para resultados de busquedas](https://docs.r-universe.dev/publish/metadata.html#keywords).
1313

1414
Recomendamos:
1515

maintenance_github_grooming.pt.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Atualmente, os pacotes da rOpenSci são, em sua grande maioria, desenvolvidos no
1010

1111
### Áreas de repositório do GitHub {#git-hub-repo-topics}
1212

13-
As [áreas de repositório](https://blog.github.com/2017-01-31-introducing-topics/) do GitHub ajudam a navegar e pesquisar repositórios do GitHub, são usadas pelo [R-universe em páginas de pacotes e para resultados de pesquisa](https://docs.r-universe.dev/publish/metadata.html#keywords). Também são processadas pelo [`codemetar`](https://github.com/ropensci/codemetar) nas palavras-chave de registro da rOpenSci.
13+
As [áreas de repositório](https://blog.github.com/2017-01-31-introducing-topics/) do GitHub ajudam a navegar e pesquisar repositórios do GitHub, são usadas pelo [R-universe em páginas de pacotes e para resultados de pesquisa](https://docs.r-universe.dev/publish/metadata.html#keywords).
1414

1515
Recomendamos:
1616

pkg_building.Rmd

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@ We recommend that package developers read Hadley Wickham and Jenny Bryan's thoro
2727

2828
- Find other interesting aspects of naming your package [in this blog post by Nick Tierney](https://www.njtierney.com/post/2018/06/20/naming-things/), and in case you change your mind, find out [how to rename your package in this other blog post of Nick's](https://www.njtierney.com/post/2017/10/27/change-pkg-name/).
2929

30-
### Creating metadata for your package {#creating-metadata-for-your-package}
31-
32-
We recommend you to use the [`codemetar` package](https://github.com/ropensci/codemetar) for creating and updating a JSON [CodeMeta](https://codemeta.github.io/) metadata file for your package via `codemetar::write_codemeta()`. It will automatically include all useful information, including [GitHub topics](#grooming). CodeMeta uses [Schema.org terms](https://schema.org/) so as it gains popularity the JSON metadata of your package might be used by third-party services, maybe even search engines.
3330

3431
## Platforms {#platforms}
3532

pkg_building.es.Rmd

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,6 @@ Para leer por qué vale la pena enviar un paquete a rOpenSci siguiendo las recom
2626
- [Este artículo de Nick Tierney (en inglés)](https://www.njtierney.com/post/2018/06/20/naming-things/) lista otras consideraciones interesantes a tener en cuenta al nombrar paquetes de R.
2727
En caso de que cambies de opinión sobre el nombre de tu paquete, este segundo artículo de Nick explica [cómo cambiar el nombre de tu paquete](https://www.njtierney.com/post/2017/10/27/change-pkg-name/).
2828

29-
### Crear metadatos para tu paquete {#creating-metadata-for-your-package}
30-
31-
Recomendamos usar el [paquete `codemetar`](https://github.com/ropensci/codemetar) para crear y actualizar un archivo JSON [CodeMeta](https://codemeta.github.io/) para tu paquete usando `codemetar::write_codemeta()`.
32-
Incluirá automáticamente toda la información útil, incluyendo [temas de GitHub](#grooming).
33-
CodeMeta utiliza [términos de Schema.org](https://schema.org/) por lo que, a medida que gane popularidad, los metadatos JSON de tu paquete podrían ser utilizados por servicios de terceros, incluso por motores de búsqueda.
34-
3529
## Plataformas {#platforms}
3630

3731
- Los paquetes deben funcionar en todas las plataformas principales (Windows, macOS, Linux). Puede haber excepciones para paquetes que interactúen con funciones específicas del sistema, o que adapten utilidades que sólo funcionan en plataformas limitadas, pero se debe hacer todo lo posible para garantizar la compatibilidad entre plataformas, incluyendo la compilación específica en cada sistema, o la contenerización de utilidades externas.

pkg_building.pt.Rmd

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,6 @@ Recomendamos que as pessoas desenvolvedoras de pacotes leiam o livro completo de
2727

2828
- Encontre outros aspectos interessantes sobre como nomear seu pacote [neste texto do blog do Nick Tierney (em inglês)](https://www.njtierney.com/post/2018/06/20/naming-things/) e, caso você mude de ideia, descubra [como renomear seu pacote nesta outra postagem do blog do Nick](https://www.njtierney.com/post/2017/10/27/change-pkg-name/).
2929

30-
### Criando metadados para seu pacote {#creating-metadata-for-your-package}
31-
32-
Recomendamos que você use o [pacote `codemetar`](https://github.com/ropensci/codemetar) para criar e atualizar um arquivo JSON [CodeMeta](https://codemeta.github.io/) para seu pacote por meio de `codemetar::write_codemeta()`. Ele incluirá automaticamente todas as informações úteis, incluindo [tópicos do GitHub](#grooming). O CodeMeta usa [termos do Schema.org](https://schema.org/), portanto, à medida que ganha popularidade, os metadados JSON do seu pacote podem ser usados por serviços de terceiros, talvez até por mecanismos de pesquisa.
33-
3430
## Plataformas {#platforms}
3531

3632
- Os pacotes devem funcionar em todas as principais plataformas (Windows, macOS, Linux). Pode haver exceções para pacotes que interajam com funções específicas do sistema ou que adaptem utilitários que só funcionam em plataformas limitadas, mas deve-se fazer todo o possível para garantir a compatibilidade entre plataformas, incluindo a compilação específica em cada sistema ou a containerização de utilitários externos.

0 commit comments

Comments
 (0)