From 044c1b3bb8434109eea5e0fe44448591f72cb3ff Mon Sep 17 00:00:00 2001 From: Jason Baker Date: Sun, 22 Dec 2024 10:28:13 -0800 Subject: [PATCH] perf: change master to main branch --- docs/upstream.md | 22 +++++++++++----------- package.json | 2 +- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/upstream.md b/docs/upstream.md index 83b2512..3cd4027 100644 --- a/docs/upstream.md +++ b/docs/upstream.md @@ -1,6 +1,6 @@ # Maintaining your fork's upstream relationship -So you forked this repo. That's awesome. But don't forget you keep your `master` branch in sync with the upstream `master` branch to ensure that your pull requests will always be able to be merged. +So you forked this repo. That's awesome. But don't forget you keep your `main` branch in sync with the upstream `main` branch to ensure that your pull requests will always be able to be merged. ## How to sync with upstream? @@ -42,39 +42,39 @@ upstream https://github.com/AlaskaAirlines/auro-popover.git (push) #### Sync upstream -To sync your `master` branch with the upstream `master` branch, there are two ways you can do this. The preferred method is to fetch and rebase. Please do not merge down. +To sync your `main` branch with the upstream `main` branch, there are two ways you can do this. The preferred method is to fetch and rebase. Please do not merge down. ```bash -$ git checkout master +$ git checkout main $ git fetch upstream -$ git rebase upstream/master +$ git rebase upstream/main ``` Then to sync your feature brach, ```bash $ git checkout feature-branch -$ git rebase master +$ git rebase main ``` #### Brute force -In the case where your `master` branch's history is not in sync with the upstream, then you have few options. The nuclear option is to trash the fork and re-fork, but there is an easier way. the following step will force reset your `master` branch with that of the upstream `master` branch. +In the case where your `main` branch's history is not in sync with the upstream, then you have few options. The nuclear option is to trash the fork and re-fork, but there is an easier way. the following step will force reset your `main` branch with that of the upstream `main` branch. ```bash -$ git reset --hard upstream/master +$ git reset --hard upstream/main ``` Just to make sure that all things are synced correctly, run the following: ```bash -$ git checkout master +$ git checkout main $ git fetch upstream -$ git merge upstream/master +$ git merge upstream/main ``` -## mastertain upstream +## maintain upstream -Once you have connected your local forked clone to the upstream repo, mastertenance is the key. It is important to ensure that your `master` branch is always updated BEFORE you create a new branch intended to be used with a new pull request. This will help to eliminate any potential issues with merging when the `master` branches are out of sync. +Once you have connected your local forked clone to the upstream repo, maintenance is the key. It is important to ensure that your `main` branch is always updated BEFORE you create a new branch intended to be used with a new pull request. This will help to eliminate any potential issues with merging when the `main` branches are out of sync. diff --git a/package.json b/package.json index 38ae498..68e4946 100644 --- a/package.json +++ b/package.json @@ -95,7 +95,7 @@ "release": { "branches": [ { - "name": "master" + "name": "main" }, { "name": "beta",