Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 2.03 KB

rebasing.md

File metadata and controls

65 lines (45 loc) · 2.03 KB

Rebasing

Keeping Your Fork and Branch Up to Date with Main

Rebases keep your branch in-sync with the upstream main, meaning you are working on the latest version of the codebase. This means the methods you are using are up-to-date and you avoid merge-conflicts.

Step by Step Guide to Rebase

1. Add the original repo as a remote called "upstream"

Only do this once per repository clone.

If not already done:

git remote add upstream https://github.com/hiero-ledger/hiero-sdk-python.git

2. Sync your main on your fork

Each time you want to sync:

  • Sync your fork's main with the upstream main changes:
  git checkout main
  git fetch upstream
  git pull upstream main
  git push origin main

You can also do this by visiting your repository "https://github.com/YOUR_GITHUB_NAME/hiero-website" and clicking the sync fork button which is a few lines from the top near the right. Then pull these changes locally in Github Desktop.

3. Sync your working branch

Your fork’s main branch is now up to date, but your working branch is not.

To bring your branch in sync with the latest changes, apply a rebase.
This keeps history clean and ensures your commits remain eligible for review.

To rebase:

git checkout mybranch
git rebase main -S

⚠️ Always include the -S flag
⚠️ Do NOT merge main into your branch

4. Verify Sign Status

Verify after the rebase operation, your commits are still signed correctly:

git log -n 5 --pretty=format:'%h %an %G? %s'

Replacing 5 with the number of commits you want to check back in history. You should see G (valid signature). If you experience signing issues, read Signing Guide

Handling Conflicts:

If conflicts occur during rebase, See Merge Conflict Guide for detailed guidance.

⚠️ Regularly rebase your branch to avoid merge conflicts

Helpful Resources