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

Content in Merging PRs is incorrect #26546

Closed
1 task done
Winson-Huang opened this issue Jul 8, 2023 · 7 comments
Closed
1 task done

Content in Merging PRs is incorrect #26546

Winson-Huang opened this issue Jul 8, 2023 · 7 comments
Labels
content This issue or pull request belongs to the Docs Content team

Comments

@Winson-Huang
Copy link

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request

https://github.com/github/docs/blob/main/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md

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

In the section "About pull request merges", content says:

Pull requests are merged using the --no-ff option, except for pull requests with squashed or rebased commits, which are merged using the fast-forward option.

However, as about-pull-request-merges says, and as issue #1387 and PR #11373 mentioned, PRs with rebased commits are NOT merged with fast-forward. The content aforementioned should be:

Pull requests are merged using the --no-ff option, except for pull requests with squashed commits, which are merged using the fast-forward option.

Additional information

No response

@Winson-Huang Winson-Huang added the content This issue or pull request belongs to the Docs Content team label Jul 8, 2023
@welcome
Copy link

welcome bot commented Jul 8, 2023

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 Jul 8, 2023
Winson-Huang added a commit to Winson-Huang/docs that referenced this issue Jul 8, 2023
@cmwilson21
Copy link
Contributor

@Winson-Huang Thank you for opening an issue and linking it to your PR! ✨

@Pnythail

This comment was marked as spam.

@Pnythail

This comment was marked as spam.

@cmwilson21 cmwilson21 removed the triage Do not begin working on this issue until triaged by the team label Jul 24, 2023
@sophietheking
Copy link
Contributor

Hi @Winson-Huang 👋 Thanks for creating an issue and contributing to our docs, we really appreciate it! ✨ However, after careful consideration, we've found that your suggested change is not needed at the moment because the docs are accurate.

In the issue you raised, you mentioned:

However, as about-pull-request-merges says, and as issue #1387 and PR #11373 mentioned, PRs with rebased commits are NOT merged with fast-forward.

While we value your input, we must clarify that our existing documentation covers this scenario. The "Rebase and merge your commits" section says:

When you select the Rebase and merge option on a pull request on GitHub.com, all commits from the topic branch (or head branch) are added onto the base branch individually without a merge commit. In that way, the rebase and merge behavior resembles a fast-forward merge

Since we have the information correctly represented, we have decided to close this issue. Nevertheless, we really appreciate you contributing to the community, and we encourage you to continue contributing in the future! 💖 Keep up the fantastic work! 🌟

@sophietheking sophietheking closed this as not planned Won't fix, can't repro, duplicate, stale Jul 25, 2023
@Winson-Huang
Copy link
Author

I think there may be some misunderstanding here. Firstly I'd like to make sure we all agree that "rebase and merge" DOES NOT use fast-forward, right? (It just resembles a fast-forward)

Then, in PR #26547 I just want to fix the inconsistency between this fact and contents below:

Pull requests are merged using the --no-ff option, except for pull requests with squashed or rebased commits, which are merged using the fast-forward option.

which are located this page in docs.

Please don't mix up "About pull request merges" section in this page and another independent About pull request merges page.

May be there is a better fix, but I think the inconsistency in docs definitely exists, shouldn't be ignored.

@Winson-Huang
Copy link
Author

Maybe this issue need reopen...

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants