From cda478006a900428e336bc1ead9141b53277a859 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Thu, 9 Feb 2023 13:21:17 +0100 Subject: [PATCH 1/6] Improve GitHub workflow guidance --- NEWS.md | 2 +- booknews.Rmd | 6 ++++-- maintenance_collaboration.Rmd | 14 ++++++++++---- maintenance_collaboration.es.Rmd | 9 ++++++++- 4 files changed, 23 insertions(+), 8 deletions(-) diff --git a/NEWS.md b/NEWS.md index 55130c3f5..2a5d735ae 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1 +1 @@ -https://github.com/ropensci/dev_guide/blob/master/appendix.Rmd#news +https://github.com/ropensci/dev_guide/blob/main/booknews.Rmd diff --git a/booknews.Rmd b/booknews.Rmd index 569a0384e..f214cea31 100644 --- a/booknews.Rmd +++ b/booknews.Rmd @@ -2,9 +2,11 @@ ## dev (0.9.0) -- 2023-01-25, add Mastodon as social media (#592, by @yabellini). +- 2022-07-04, Add resources around GitHub workflows (#479, `@maurolepore`). -- 2023-01-20, fix small formating error (#590 by @eliocamp). +- 2023-01-25, add Mastodon as social media (#592, by `@yabellini`). + +- 2023-01-20, fix small formating error (#590 by `@eliocamp`). - 2022-11-22, mention shinytest2 near shinytest. diff --git a/maintenance_collaboration.Rmd b/maintenance_collaboration.Rmd index 65964ddc5..a1a46a287 100644 --- a/maintenance_collaboration.Rmd +++ b/maintenance_collaboration.Rmd @@ -105,20 +105,26 @@ A possible model for onboarding collaborators is provided by Jim Hester in [his If your problem is _recruiting_ collaborators, you can post an open call like Jim Hester's [on Twitter](https://twitter.com/jimhester_/status/997109466674819074), [GitHub](https://github.com/jimhester/lintr/issues/318), and as an rOpenSci package author, you can ask for help in rOpenSci slack and ask rOpenSci team for ideas for recruiting new collaborators. -### Working with collaborators (including yourself) {#gitflow} +### Working with collaborators (including yourself) {#git-workflow} [Branches](https://happygitwithr.com/git-branches.html) are cheap. Use them extensively when developing features, testing out new ideas, fixing problems. One of the branches is the default / main branch, where, if you follow [trunk-based development](https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development), you "merge small, frequent updates". See also [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) and [GitLab flow](https://docs.gitlab.com/ee/topics/gitlab_flow.html) docs. -You might want to pair the frequent incrementing of version numbers (in `DESCRIPTION`). +You might want to frequently increment version numbers (in `DESCRIPTION`). One particular aspect of working with collaborators is reviewing pull requests, with some useful guidance in: -* [The Art of Giving and Receiving Code Reviews (Gracefully), by Alex Hill](https://www.alexandra-hill.com/2018/06/25/the-art-of-giving-and-receiving-code-reviews/) -* [GitHub documentation about PR reviews](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) +* [The Art of Giving and Receiving Code Reviews (Gracefully), by Alex Hill](https://www.alexandra-hill.com/2018/06/25/the-art-of-giving-and-receiving-code-reviews/); +* [GitHub documentation about PR reviews](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews). + +You might want to tinker with your GitHub repository settings to, for instance, [require pull request reviews before merging](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging=). +See also GitHub docs about ["code owners"](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). For making and reviewing pull requests we recommend [exploring usethis functions](https://usethis.r-lib.org/articles/pr-functions.html). +For your "git remote" setup refer to [happy git with r](https://happygitwithr.com/common-remote-setups.html). +See also [Useful Git patterns for real life](https://happygitwithr.com/workflows-intro.html) in the same book. + ### Be generous with attributions {#attributions} If someone contributes to your repository consider adding them in DESCRIPTION, as contributor ("ctb") for small contributions, author ("aut") for bigger contributions. Traditionally when citing a package in a scientific publication only "aut" authors are listed, not "ctb" contributors; and on `pkgdown` websites only "aut" names are listed on the homepage, all authors being listed on the authors/ page. diff --git a/maintenance_collaboration.es.Rmd b/maintenance_collaboration.es.Rmd index b69ee10a2..cd7b37044 100644 --- a/maintenance_collaboration.es.Rmd +++ b/maintenance_collaboration.es.Rmd @@ -110,7 +110,7 @@ Jim Hester ofrece un posible modelo de incorporación de miembros de equipo en [ Si tu problema es *reclutar* nuevas personas, puedes publicar una convocatoria abierta como la de Jim Hester [en Twitter](https://twitter.com/jimhester_/status/997109466674819074), [GitHub](https://github.com/jimhester/lintr/issues/318) y, como responsable de un paquete de rOpenSci, puedes pedir ayuda en el Slack de rOpenSci y solicitar al equipo de rOpenSci ideas para reclutar ayuda. -### Trabajar con otras personas (y incluyendo tú en el futuro) {#gitflow} +### Trabajar con otras personas (y incluyendo tú en el futuro) {#git-workflow} [Las *branches*](https://happygitwithr.com/git-branches.html) son baratas. Utilízalas mucho cuando desarrolles funciones, pruebes nuevas ideas o arregles problemas. @@ -124,8 +124,15 @@ Pueden ver algunas guías útiles en: - [*The Art of Giving and Receiving Code Reviews (Gracefully)* (El arte de dar y recibir revisiones de código (con elegancia)), por Alex Hill](https://www.alexandra-hill.com/2018/06/25/the-art-of-giving-and-receiving-code-reviews/) - [Documentación de GitHub sobre revisiones de PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) +Puedes modificar la configuración de tu repositorio de GitHub, +por ejemplo [requeriendo revisiones de solicitudes de cambio antes de fusionarlas](https://docs.github.com/es/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging). +También puedes consultar la documentación [Acerca de los propietarios de código](https://docs.github.com/es/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). + Para hacer y revisar *pull requests* recomendamos [explorar las funciones del paquete usethis](https://usethis.r-lib.org/articles/pr-functions.html). +Para tu configuración "git remote" consulte [happy git with r](https://happygitwithr.com/common-remote-setups.html). +También es útil [Useful Git patterns for real life](https://happygitwithr.com/workflows-intro.html) en el mismo libro. + ### Atribuye con generosidad {#attributions} Si una persona contribuye a tu repositorio, considera añadirla en el archivo DESCRIPTION, con el rol de contribución ("ctb") para pequeñas contribuciones o autoría ("aut") para contribuciones mayores. From e254685514094f00e6ee5bcdbfd3984c5472568a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Thu, 16 Feb 2023 11:19:51 +0100 Subject: [PATCH 2/6] Update maintenance_collaboration.es.Rmd Co-authored-by: Yanina Bellini Saibene --- maintenance_collaboration.es.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maintenance_collaboration.es.Rmd b/maintenance_collaboration.es.Rmd index cd7b37044..9e352a316 100644 --- a/maintenance_collaboration.es.Rmd +++ b/maintenance_collaboration.es.Rmd @@ -110,7 +110,7 @@ Jim Hester ofrece un posible modelo de incorporación de miembros de equipo en [ Si tu problema es *reclutar* nuevas personas, puedes publicar una convocatoria abierta como la de Jim Hester [en Twitter](https://twitter.com/jimhester_/status/997109466674819074), [GitHub](https://github.com/jimhester/lintr/issues/318) y, como responsable de un paquete de rOpenSci, puedes pedir ayuda en el Slack de rOpenSci y solicitar al equipo de rOpenSci ideas para reclutar ayuda. -### Trabajar con otras personas (y incluyendo tú en el futuro) {#git-workflow} +### Trabajar con otras personas (incluyendo tú en el futuro) {#git-workflow} [Las *branches*](https://happygitwithr.com/git-branches.html) son baratas. Utilízalas mucho cuando desarrolles funciones, pruebes nuevas ideas o arregles problemas. From cb3a4621b18683783e16c0cf83459b439b734c28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Thu, 16 Feb 2023 11:19:58 +0100 Subject: [PATCH 3/6] Update maintenance_collaboration.es.Rmd Co-authored-by: Yanina Bellini Saibene --- maintenance_collaboration.es.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maintenance_collaboration.es.Rmd b/maintenance_collaboration.es.Rmd index 9e352a316..ee0f5410f 100644 --- a/maintenance_collaboration.es.Rmd +++ b/maintenance_collaboration.es.Rmd @@ -126,7 +126,7 @@ Pueden ver algunas guías útiles en: Puedes modificar la configuración de tu repositorio de GitHub, por ejemplo [requeriendo revisiones de solicitudes de cambio antes de fusionarlas](https://docs.github.com/es/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging). -También puedes consultar la documentación [Acerca de los propietarios de código](https://docs.github.com/es/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). +También puedes consultar la documentación [acerca de propiedad sobre código](https://docs.github.com/es/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). Para hacer y revisar *pull requests* recomendamos [explorar las funciones del paquete usethis](https://usethis.r-lib.org/articles/pr-functions.html). From 8671d8e1d93e9b67fd1f681ece579515c1020fee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Thu, 16 Feb 2023 11:20:05 +0100 Subject: [PATCH 4/6] Update maintenance_collaboration.es.Rmd Co-authored-by: Yanina Bellini Saibene --- maintenance_collaboration.es.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maintenance_collaboration.es.Rmd b/maintenance_collaboration.es.Rmd index ee0f5410f..dad5f29ce 100644 --- a/maintenance_collaboration.es.Rmd +++ b/maintenance_collaboration.es.Rmd @@ -130,7 +130,7 @@ También puedes consultar la documentación [acerca de propiedad sobre código]( Para hacer y revisar *pull requests* recomendamos [explorar las funciones del paquete usethis](https://usethis.r-lib.org/articles/pr-functions.html). -Para tu configuración "git remote" consulte [happy git with r](https://happygitwithr.com/common-remote-setups.html). +Para tu configuración "git remote" consulta [_Happy Git with R_](https://happygitwithr.com/common-remote-setups.html). También es útil [Useful Git patterns for real life](https://happygitwithr.com/workflows-intro.html) en el mismo libro. ### Atribuye con generosidad {#attributions} From 53cc061006cf2f4d9cc4bb6cf49958709dce0b2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Thu, 16 Feb 2023 11:20:12 +0100 Subject: [PATCH 5/6] Update maintenance_collaboration.es.Rmd Co-authored-by: Yanina Bellini Saibene --- maintenance_collaboration.es.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maintenance_collaboration.es.Rmd b/maintenance_collaboration.es.Rmd index dad5f29ce..8d323c41e 100644 --- a/maintenance_collaboration.es.Rmd +++ b/maintenance_collaboration.es.Rmd @@ -125,7 +125,7 @@ Pueden ver algunas guías útiles en: - [Documentación de GitHub sobre revisiones de PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) Puedes modificar la configuración de tu repositorio de GitHub, -por ejemplo [requeriendo revisiones de solicitudes de cambio antes de fusionarlas](https://docs.github.com/es/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging). +por ejemplo [requeriendo revisiones de solicitudes de cambio antes de aceptarlas e incorporarlas](https://docs.github.com/es/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging). También puedes consultar la documentación [acerca de propiedad sobre código](https://docs.github.com/es/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). Para hacer y revisar *pull requests* recomendamos [explorar las funciones del paquete usethis](https://usethis.r-lib.org/articles/pr-functions.html). From f75cfb3b018dc0fc8ad1d863ea1bdcdf255b2b00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Thu, 16 Feb 2023 11:20:18 +0100 Subject: [PATCH 6/6] Update maintenance_collaboration.es.Rmd Co-authored-by: Yanina Bellini Saibene --- maintenance_collaboration.es.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maintenance_collaboration.es.Rmd b/maintenance_collaboration.es.Rmd index 8d323c41e..e9867060b 100644 --- a/maintenance_collaboration.es.Rmd +++ b/maintenance_collaboration.es.Rmd @@ -131,7 +131,7 @@ También puedes consultar la documentación [acerca de propiedad sobre código]( Para hacer y revisar *pull requests* recomendamos [explorar las funciones del paquete usethis](https://usethis.r-lib.org/articles/pr-functions.html). Para tu configuración "git remote" consulta [_Happy Git with R_](https://happygitwithr.com/common-remote-setups.html). -También es útil [Useful Git patterns for real life](https://happygitwithr.com/workflows-intro.html) en el mismo libro. +También es útil la sección [Useful Git patterns for real life](https://happygitwithr.com/workflows-intro.html) en el mismo libro. ### Atribuye con generosidad {#attributions}