Skip to content

Add “Keep your PR branch in sync with main” section (rebase/merge workflow) #6

Description

@ronhedwigzape

Right now the README covers cloning/branching/PRs, but it doesn’t explain how to update an in-progress feature branch when main has new commits. This often causes last-minute conflicts and uncertainty for contributors.

Proposal
Add a short section under General Workflow (after “Pull Requests” or “Code Review”) explaining two supported ways to sync a PR branch with the base branch:

  1. Preferred (solo PR branches): Rebase onto latest origin/main
git fetch origin
git switch feat/<name>
git rebase origin/main
# resolve conflicts (if any)
git add <files>
git rebase --continue
git push --force-with-lease

Notes:

  • Mention that rebasing rewrites commit SHAs, so force push is required; recommend --force-with-lease as the safer option.
  1. Alternative (shared branches / no force-push teams): Merge origin/main into feature
git fetch origin
git switch feat/<name>
git merge origin/main
git push

Also include

  • A quick note that GitHub PRs can be updated via the Update branch dropdown (merge or rebase) as an alternative to CLI.
  • If the repo uses submodules: after syncing, run:
git submodule update --init --recursive

Acceptance criteria

  • README contains the new “Keep your PR branch in sync with main” section
  • Includes both rebase + merge command paths + when to choose each
  • Mentions GitHub “Update branch” option
  • Mentions submodule update command for repos like pillar/pillar-ui

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationdraft / need discussionIssue needs verification, discussion, or assessment before accurate instructions can be providedquestionFurther information is requestedtaskThis issue represents a task or actionable item to be completed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions