Skip to content

contrib guide: Describe how to resolve merge conflicts#8951

Open
nojnhuh wants to merge 2 commits into
kubernetes:mainfrom
nojnhuh:howto-resolve-conflicts
Open

contrib guide: Describe how to resolve merge conflicts#8951
nojnhuh wants to merge 2 commits into
kubernetes:mainfrom
nojnhuh:howto-resolve-conflicts

Conversation

@nojnhuh
Copy link
Copy Markdown
Contributor

@nojnhuh nojnhuh commented Apr 19, 2026

This PR updates the contributor guide to describe why git merge is preferable to git rebase for resolving merge conflicts while a PR is being reviewed.

Which issue(s) this PR fixes:

Fixes #

@k8s-ci-robot k8s-ci-robot added area/contributor-guide Issues or PRs related to the contributor guide sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. labels Apr 19, 2026
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 19, 2026
@jberkus
Copy link
Copy Markdown
Contributor

jberkus commented May 29, 2026

This is a good start, but I feel like a section called "Resolving Merge Conflicts" needs to provide some actual instructions on how to resolve them. Links to public git/github resources are fine, if they are good instructions.

Copy link
Copy Markdown
Contributor

@jberkus jberkus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See previous comment

Link to GtiHub docs about merge conflicts

The Kubernetes project maintains high development velocity, so it's likely other
PRs will merge which introduce merge conflicts while Feature-X is being
PRs will merge which introduce [merge conflicts] while Feature-X is being
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good start, but I feel like a section called "Resolving Merge Conflicts" needs to provide some actual instructions on how to resolve them. Links to public git/github resources are fine, if they are good instructions.

Added this link to GitHub's docs which provide a good entrypoint: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts

These are the most similar Git docs I could find about resolving conflicts, but it's a bit buried in a larger sequence of steps and not as applicable in this context: https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging#_basic_merge_conflicts

@nojnhuh
Copy link
Copy Markdown
Contributor Author

nojnhuh commented May 29, 2026

/hold for squash

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 29, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Kelleretoro, nojnhuh
Once this PR has been reviewed and has the lgtm label, please assign mrbobbytables for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

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

Labels

area/contributor-guide Issues or PRs related to the contributor guide cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants