Skip to content

Commit f319462

Browse files
authored
Add instructions regarding merging vs rebase (Android) (#2732)
1 parent 694c4fd commit f319462

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/android/submit.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,20 @@ If you're a new contributor, each CI run must be approved by a maintainer.
3535
Running CI workflows consumes significant resources. If your work is incomplete, postpone opening the PR (even in draft mode) unless necessary. Let's be mindful of resource usage and our planet. 🌍 But it doesn't prevent you from pushing regularly to avoid losing your work.
3636
:::
3737

38+
### Update your branch
39+
40+
Sometimes your branch may fall behind `main`. Before your pull request can be merged, you may need to resolve conflicts. You can update your branch in one of two ways:
41+
42+
- **Merge** the `main` branch into your branch and [resolve any conflicts](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line).
43+
- **Rebase** your branch onto `main` by following the [Git rebase documentation](https://docs.github.com/en/get-started/using-git/about-git-rebase).
44+
45+
Follow these guidelines:
46+
47+
- If your pull request has **not** been reviewed, you can rebase or merge.
48+
- If your pull request **has been reviewed**, use merge instead of rebase. Rebasing after review can break previous comments and remove valuable feedback.
49+
50+
Rebasing is optional before review; merging is always allowed. This repository uses the [squash and merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) strategy to keep commit history clean and meaningful.
51+
3852
### Review process
3953

4054
#### Who can review?

0 commit comments

Comments
 (0)