-
Notifications
You must be signed in to change notification settings - Fork 55
/
maintenance_github_grooming.es.Rmd
49 lines (28 loc) · 3.66 KB
/
maintenance_github_grooming.es.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# Gestión de GitHub {#grooming}
```{block, type="summaryblock"}
Actualmente la gran mayoría de los paquetes de rOpenSci se desarrollan en GitHub.
Aquí tienes algunos consejos para aprovechar la plataforma en una sección sobre [hacer que tu repo sea más fácil de descubrir](#repodiscoverability) y una sección sobre [publicitar tu propia cuenta de GitHub después de pasar por la revisión por pares](#marketown).
```
## Haz que tu repositorio sea fácil de descubrir {#repodiscoverability}
### Áreas de repositorio en GitHub {#git-hub-repo-topics}
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://github.com/r-universe-org/help#how-to-add-keyword-labels-to-an-r-package). También son usadas por [`codemetar`](https://github.com/ropensci/codemetar) en las palabras clave del registro de rOpenSci.
Recomendamos:
- Añadir "r", "r-package" y "rstats" como áreas al repositorio de tus paquetes.
- Añadir cualquier otra área relevante al repositorio de tus paquetes.
Es posible que te hagamos sugerencias una vez que tu paquete esté incorporado.
### Lingüista de GitHub {#git-hub-linguist}
[El lingüista de GitHub](https://github.com/github/linguist) asignará un lenguaje a tu repo en función de los archivos que contenga.
Algunos paquetes que contienen mucho código en C++ pueden ser clasificados como paquetes de C++ en lugar de R, lo cual está bien y muestra la necesidad de las áreas "r", "r-package" y "rstats".
Recomendamos anular el lingüista de GitHub añadiendo o modificando un archivo .gitattributes a tu repositorio en dos casos:
- Si almacenas archivos html en lugares no estándar (fuera en docs/, por ejemplo, en vignettes/) omite los archivos de documentación.
Añade `*.html linguist-documentation=true` a .gitattributes (como en [este ejemplo](https://github.com/ropensci/ecoengine/blob/56b64d8d29dfae430a776d1dd440b240452eb1bf/.gitattributes#L5)).
- Si tu repo contiene código que no es de tu autoría, por ejemplo, código JavaScript, añade `inst/js/* linguist-vendored` a .gitattributes (como en [este ejemplo](https://github.com/ropensci/wellknown/blob/4435eb620eeae346d2cab7d62276c29dee29a898/.gitattributes#L1)).
De este modo, la clasificación lingüística y las estadísticas de tu repositorio reflejarán mejor el código fuente que contiene, además de hacerlo más descubrible.
En particular, si el lingüista no reconoce correctamente que tu repositorio contiene principalmente código R, tu paquete no aparecerá en los resultados de búsqueda con el filtro `language:R`.
Del mismo modo, tu repositorio no podrá aparecer entre los [repos de R populares](https://github.com/trending/r).
Más información sobre las anulaciones del lingüista de GitHub [aquí](https://github.com/github/linguist#overrides).
## Publicita tu propia cuenta {#marketown}
- Como responsable de un paquete incorporado, ahora eres miembro de la organización GitHub "ropensci" de rOpenSci.
Por defecto, la pertenencia a la organización es privada; consulta [cómo hacerla pública en la documentación de GitHub](https://help.github.com/articles/publicizing-or-hiding-organization-membership/).
- Incluso después de que el repositorio de tu paquete haya sido transferido a rOpenSci, puedes [destacarlo en tu propia cuenta](https://help.github.com/articles/pinning-repositories-to-your-profile/).
- En general, recomendamos añadir al menos una imagen de perfil (¡que no tiene por qué ser tu cara!) y tu nombre [a tu perfil de GitHub](https://help.github.com/articles/customizing-your-profile/).