Skip to content

Commit 4b6c694

Browse files
maellempadgeyabellini
authored
default branch should not be "master" (#863)
* make "main" default branch a requirement * Update pkg_building.Rmd Co-authored-by: mark padgham <[email protected]> * add ES translation * changelog * Update pkg_building.es.Rmd Co-authored-by: Yanina Bellini Saibene <[email protected]> --------- Co-authored-by: mark padgham <[email protected]> Co-authored-by: Yanina Bellini Saibene <[email protected]>
1 parent 63cef03 commit 4b6c694

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
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-02-25, require the default git branch to not be called master (#863)
6+
57
- 2024-09-06, update math guidance for pkgdown based on pkgdown's update (#838)
68

79
- 2024-08-30, remove mention of Twitter since rOpenSci no longer maintains an active Twitter account (`@yabellini`, #827)

pkg_building.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,8 @@ For more explanations around licensing, refer to the [R packages book](https://r
450450
451451
- Your package source files have to be under version control, more specifically tracked with [Git](https://happygitwithr.com/). You might find the [gert package](https://docs.ropensci.org/gert/) relevant, as well as some of [usethis Git/GitHub related functionality](https://usethis.r-lib.org/reference/index.html#section-git-and-github); you can however use git as you want.
452452
453+
- The default branch name should not be `master`, as this can be offensive to some people. Refer to the [statement of the Git project and the Software Freedom Conservancy](https://sfconservancy.org/news/2020/jun/23/gitbranchname/) for more context. It is general practice to name a default branch `main`, although other names may also be used. See the tidyverse blog post ["Renaming the default branch"](https://www.tidyverse.org/blog/2021/10/renaming-default-branch/) to learn about usethis functionality to help with renaming default branches.
454+
453455
- Make sure to list "scrap" such as `.DS_Store` files in .gitignore. You might find the [`usethis::git_vaccinate()` function](https://usethis.r-lib.org/reference/git_vaccinate.html), and the [gitignore package](https://docs.ropensci.org/gitignore/) relevant.
454456
455457
- A later section of this book contains some [git workflow tips](#gitflow).

pkg_building.es.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -523,6 +523,8 @@ Para más detalles sobre las licencias, consulta el libro [R packages](https://r
523523
524524
- Los archivos fuente de tu paquete tienen que estar bajo control de versiones, más concretamente versionados con [Git](https://happygitwithr.com/).
525525
Puede que el paquete [gert](https://docs.ropensci.org/gert/) te resulte útil, así como algunas de las [funciones de usethis relacionadas con Git/GitHub](https://usethis.r-lib.org/reference/index.html#section-git-and-github); sin embargo, puedes utilizar git como quieras.
526+
527+
- El nombre de rama por defecto no debe ser `master` ya que puede resultar ofensivo para algunas personas. Consulta la [declaración del proyecto Git y de la Software Freedom Conservancy](https://sfconservancy.org/news/2020/jun/23/gitbranchname/) para más contexto. Es práctica general nombrar a la rama por defecto `main` aunque también pueden utilizarse otros nombres. Consulta el artículo de tidyverse ["Cambiar el nombre de la rama por defecto"](https://www.tidyverse.org/blog/2021/10/renaming-default-branch/) para aprender a utilizar esta funcionalidad para renombrar las ramas por defecto.
526528
527529
- Asegúrate de listar archivos innecesarios, como `.DS_Store`, en .gitignore.
528530
La función [`usethis::git_vaccinate()`](https://usethis.r-lib.org/reference/git_vaccinate.html), y el paquete [gitignore](https://docs.ropensci.org/gitignore/) pueden resultarte útil para esto.

0 commit comments

Comments
 (0)