Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Clarify resolving merge conflicts section #227

Closed
BekahHW opened this issue Dec 6, 2023 · 1 comment · Fixed by #232
Closed

fix: Clarify resolving merge conflicts section #227

BekahHW opened this issue Dec 6, 2023 · 1 comment · Fixed by #232
Assignees
Labels

Comments

@BekahHW
Copy link
Member

BekahHW commented Dec 6, 2023

          This page is using a closed PR as an example and gives instructions based on the PR.

Currently, it's a little bit difficult to understand what's going on here. For example, we have a "Repository Setup" section, which I think is not necessary here (the open-sauced repo that is used here also has been archived).

We might want to consider to re-write/simplify this section. Think of having these:

  • Why merge conflicts commonly happen in the OpenSauced repos (maybe mention the repos?) --> This is explained in the 1st sentence of the intro.
  • How to update branches (origin and local) section.
  • How to resolve conflicts section — including commit and push changes.
  • More simple and general technical examples.
  • Keep the Dependency Updates section.

## Update
First, get the default branch changes:
```shell
git fetch origin --recurse-submodules=no --progress --prune
git checkout main --
git fetch upstream --recurse-submodules=no --progress --prune
git merge upstream/main --no-stat -v
```

  • We might want to change the title to "Updating Local Branch".
  • Looking at the commands, this instruction is updating and merging the upstream with the local main branch. We might want to use working branch as instruction instead of main for best practice.
  • There is a separate section to merge branches, but we have a command to merge here: git merge upstream/main --no-stat -v.
  • Is the git merge command above the same with below command from the next section, "Merge with upstream"? If not, then we are having different merging instruction.

git merge origin/main --no-ff -v

Originally posted by @adiati98 in #213 (comment)

Copy link
Contributor

🎉 This issue has been resolved in version 1.57.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants