Skip to content

Recommend users to rename their fork's default branch #1734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 3, 2025
Merged

Recommend users to rename their fork's default branch #1734

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
982c525
Recommend users to rename their fork's default branch
Kobzol Nov 2, 2025
3d3dae6
Reword suggestion
Kobzol Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/inside-rust/renaming-the-default-branch-of-rust-lang-rust.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ We will be renaming the default branch of the [rust-lang/rust repository](https:

If you maintain a tool that currently assumes the default branch of `rust-lang/rust` is named `master`, using `HEAD` instead will work both before and after the rename.

After the rename, contributors will need to run the following commands in their local checkout of the repository, assuming that your remote registry is called `origin`:
After the rename, contributors will need to run the following commands in their local checkout of the repository, assuming that your upstream remote is called `origin`:

```bash
git branch -m master main
Expand All @@ -27,6 +27,8 @@ git remote prune origin

If you have a fork of the `rust-lang/rust` repository on GitHub and would like to rename your default branch to match, you can follow [GitHub's instructions][github-how-to-rename].

**We recommend renaming the default branch of your fork.** If you do not rename it and later run `git checkout master`, git will create a`master` branch based on your fork's outdated `master` branch. This behavior can be confusing.

[github-change]: https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/

[github-tooling]: https://github.com/github/renaming
Expand Down