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

Description of rebase merge method is incorrect #1387

Closed
spikyjt opened this issue Nov 16, 2020 · 4 comments · Fixed by #11373
Closed

Description of rebase merge method is incorrect #1387

spikyjt opened this issue Nov 16, 2020 · 4 comments · Fixed by #11373
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@spikyjt
Copy link

spikyjt commented Nov 16, 2020

What article on docs.github.com is affected?

https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/about-merge-methods-on-github

Contained in:
https://github.com/github/docs/blob/main/content/github/administering-a-repository/about-merge-methods-on-github.md

Which reads from:
https://github.com/github/docs/blob/main/data/reusables/pull_requests/rebase_and_merge_summary.md

What part(s) of the article would you like to see updated?

In the section Rebasing and merging your commits, the description says

Pull requests with rebased commits are merged using the fast-forward option.

However, this is not the case. Rebasing is actually done with the --force option as described later in the section where it clarifies that the commit hash and the committer will change. This is explicitly forced rebase behaviour and quite different from fast-forward, which leaves all commits as-is.

Additional information

I consider this confusing, as someone looking for a fast-forward merge option might stop at the end of the intro, thinking they have found the option they need, but in fact will get different behaviour.

@welcome
Copy link

welcome bot commented Nov 16, 2020

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 16, 2020
@bk2204
Copy link
Contributor

bk2204 commented Nov 19, 2020

Hey,

I've looked at what's going on here, and you're correct that the committer information is updated to reflect the person performing the merge. I'm not sure, but I think what might have been intended by this is that the branch is rebased by the person doing the merge and then merged into the base branch with git merge --ff-only, which, while technically accurate, is a little confusing.

I agree that things could be rephrased to be a little clearer here about the behavior.

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue labels Nov 19, 2020
@janiceilene janiceilene removed the triage Do not begin working on this issue until triaged by the team label Nov 19, 2020
@janiceilene janiceilene added the needs content strategy Wait to open a PR until there's an approved content strategy in the issue label Jun 18, 2021
@ramyaparimi
Copy link
Contributor

@spikyjt Sorry for the delay 💛 @bk2204 explained the expected behavior ✨ You or anyone is welcome to open a PR clarifying the behavior in the article. 💖

@ramyaparimi ramyaparimi removed the needs content strategy Wait to open a PR until there's an approved content strategy in the issue label Sep 29, 2021
@devtayls
Copy link
Contributor

Can I be assigned this?

This was referenced Jan 18, 2022
jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this issue Oct 6, 2022
…o 1.0.13 (github#1383)" (github#1387)

This reverts commit 2fba873 to debug a link-checking problem.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants
@bk2204 @spikyjt @janiceilene @devtayls @ramyaparimi and others