r-lib / commonmark

High Performance CommonMark and Github Markdown Rendering in R
https://docs.ropensci.org/commonmark/
Other
88 stars 11 forks source link

Move `master` branch to `main` #16

Closed jennybc closed 2 years ago

jennybc commented 3 years ago

The master branch of this repository will soon be renamed to main, as part of a coordinated change across several GitHub organizations (including, but not limited to: tidyverse, r-lib, tidymodels, and sol-eng). We anticipate this will happen by the end of September 2021.

That will be preceded by a release of the usethis package, which will gain some functionality around detecting and adapting to a renamed default branch. There will also be a blog post at the time of this master --> main change.

The purpose of this issue is to:

message id: euphoric_snowdog

jennybc commented 2 years ago

I have moved the default branch from master to main here (and elsewhere)!

This blog post announces the larger effort and explains how contributors can update their local environments:

Renaming the default branch

Here's the TL;DR:

  1. Update usethis (you want usethis v2.1.2 or higher):
    install.packages("usethis")
  2. Anyone with an existing fork or clone can adjust to the renamed default branch with:
    usethis::git_default_branch_rediscover()

    If you wish, you can read the documentation for git_default_branch_rediscover(). Or do the command line equivalent (see the blog post).

message id: goofy_chipmunk