Skip to content

Description of rebase merge method is incorrect #1387

Closed
@spikyjt

Description

@spikyjt

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamhelp wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions