Skip to content

Add tip about merge over rebase #2144

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

mate-h
Copy link
Contributor

@mate-h mate-h commented Jun 3, 2025

After a quick discussion in discord, I decided to read through the contributing guidelines in Bevy and found there is no mention of rebase or merge, so I added this sentence!

Copy link
Member

@janhohenheim janhohenheim left a comment

Choose a reason for hiding this comment

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

Good addition, I get annoyed by this as well :D

@janhohenheim janhohenheim added the S-Ready-For-Final-Review Ready for a maintainer to consider for merging label Jun 3, 2025
@Zeophlite
Copy link

My two cents: when a PR is still drafting, I tend to rebase it a bit, I think maybe limit this to things that are S-Needs-Review or later (or similar)

@@ -86,7 +86,8 @@ If you're new to Bevy, here's the workflow we use:
* You can also use the CLI tool by installing [typos-cli](https://github.com/crate-ci/typos?tab=readme-ov-file#install) and running `typos` to check for typos, and fix them by running `typos -w`.
8. Push your changes to your fork on GitHub and open a Pull Request.
9. Respond to any CI failures or review feedback. While CI failures must be fixed before we can merge your PR, you do not need to *agree* with all feedback from your reviews, merely acknowledge that it was given. If you cannot come to an agreement, leave the thread open and defer to a Maintainer or the Project Lead's final judgement.
10. When your PR is ready to merge, a Maintainer or the Project Lead will review it and suggest final changes. If those changes are minimal they may even apply them directly to speed up merging.
10. When updating your PR branch, please avoid force pushing as it can disrupt GitHub notifications and make it harder for reviewers to track changes. Instead, merge the main branch into your feature branch when you need to resolve conflicts or update your PR.
Copy link
Member

Choose a reason for hiding this comment

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

I would prefer to propose the "good" solution first, and then the thing to avoid later. also, this should be as weakly worded as possible: git is not easy, people are free to use whatever they're confident using

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Roger that, let's reword.

@alice-i-cecile alice-i-cecile added S-Waiting-On-Author A-Contributing-Guide and removed S-Ready-For-Final-Review Ready for a maintainer to consider for merging labels Jun 3, 2025
@alice-i-cecile
Copy link
Member

I agree with Francois's comment above :)

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

Successfully merging this pull request may close these issues.

6 participants