Repository navigation
docs: fix fork synchronization instructions - #338
Conversation
|
🚀 IvorySQL-Docs Preview Ready
|
|
Thanks for fixing the synchronization instructions and updating both READMEs. Could we use <target-branch> instead of hardcoding v5.6? Both master and v5.6 are maintained, so the instructions should explain that contributors need to select the branch their PR will target: git fetch upstream Please clarify that <target-branch> must be replaced with the actual branch name, such as master or v5.6. Also, if the target branch does not exist locally, git switch <target-branch> can fail because both remotes contain a matching branch. Please document explicitly creating it with git switch -c <target-branch> --track origin/<target-branch> in that case, and keep both language versions aligned. |
Use <target-branch> in both synchronization guides and explain that it must be replaced with the PR's actual target, such as master or v5.6. Document explicitly creating a missing local branch tracking origin to avoid ambiguous remote branch guessing. Keep both READMEs aligned. Validate both branch names with existing and missing local branches in both languages, including divergence rejection, using local fixtures.
|
🚀 IvorySQL-Docs Preview Ready
|
Both contribution READMEs tell contributors to merge
upstream/main, but this repository has nomainbranch. A fresh clone of a contributor's fork also does not have anupstreamremote configured.Update both READMEs to explain the one-time upstream setup and selecting the branch the PR will target. Use
<target-branch>throughout, with instructions to replace it with a real branch name such asmasterorv5.6. If the branch does not exist locally, explicitly create it trackingorigin/<target-branch>so Git does not have to choose between matching branches on both remotes. Synchronize withupstream/<target-branch>using a fast-forward merge, then push to the fork. Explain saving local changes and resolving divergent histories before pushing.Validation:
masterandv5.6, and existing and missing local target branches. Each local branch and fork reached the incoming upstream commit.git switcherror when the local target branch is absent and both remotes contain it; verified the explicit creation command tracksorigin/<target-branch>.--ff-onlyrejects divergent histories and preserves both the local commit and the fork in all eight scenarios.git diff --checkpassed.Initial error reproduction ran with Git for Windows. The expanded target-branch validation ran in WSL Ubuntu with Git 2.43.0. All validation pushes targeted local fixture repositories.