Merging Downstream

How-to for merging changes from upstream to our fork

Mostly taken from Github's documentation with some notes for clarity.

# Checkout a new branch based on main
git checkout main
git pull
git checkout -b upstream-merge
# Fetch upstream/dev branch to ensure it's up to date
# This assumes that you have configured upstream
git fetch upstream dev
# Merge from the default upstream branch into the new branch
git pull --no-ff upstream dev
# There will likely be merge conflicts. Resolve them.
# Commit all the files in a merge commit.
git commit
# Push the new branch to the origin
git push --set-upstream origin upstream-merge

Open a PR for merging upstream-merge into main. Fix anything broken by the merge, committing changes to upstream-merge. Once ready, merge the branch to main.

** IMPORTANT **

Once the PR is approved, merge using the "Create a merge commit" option. Do not "Squash and merge".