Skip to content

Docs(merge_strategies): Clarfiy rebase and ff merge similarity #11373

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

Merged
merged 6 commits into from
Nov 4, 2021

Conversation

devtayls
Copy link
Contributor

@devtayls devtayls commented Oct 23, 2021

Why:

Closes 1387

What's being changed:

Content Changes

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

to:

In that way, the rebase and merge behavior resembles a fast-forward merge by maintaining a linear project history. However, rebasing achieves this by re-writing the commit history on the base branch with new commits.

This is because as @bk2204, @spikyjt explained in the issue, rebasing looks like ff-merge, but in actuality is a destructive method which changes the project history.

Refactor

Move paragraph on enabling Rebase and Merge behind paragraph explaining how rebasing works on Github. This flows better as: 'What is rebase and merge?' -> 'How do I enable Rebase and Merge?' Than the previous version which was: 'What is rebase and merge?' -> 'How do I enable Rebase and Merge' -> 'How github rebase differs from git rebase'

Check off the following:

  • I have reviewed my changes in staging (look for the latest deployment event in your pull request's timeline, then click View deployment).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@welcome
Copy link

welcome bot commented Oct 23, 2021

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

@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! labels Oct 25, 2021
@ramyaparimi
Copy link
Contributor

@devtayls
Thanks so much for opening a PR! I'll get this triaged for review ⚡

Copy link
Member

@lecoursen lecoursen left a comment

Choose a reason for hiding this comment

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

Thanks @devtayls, this looks great! I'm applying a suggestion with a few small style tweaks and will merge after CI finishes! ⚡

@lecoursen
Copy link
Member

The link check errors are unrelated to this PR.

@lecoursen lecoursen merged commit 5297a44 into github:main Nov 4, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2021

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

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 hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Description of rebase merge method is incorrect
3 participants