From f319462af04a412283e1ae41ff5b1eb79ec4e52a Mon Sep 17 00:00:00 2001 From: Timothy <6560631+TimoPtr@users.noreply.github.com> Date: Wed, 23 Jul 2025 21:37:32 +0200 Subject: [PATCH] Add instructions regarding merging vs rebase (Android) (#2732) --- docs/android/submit.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/android/submit.md b/docs/android/submit.md index afb0bf05..e8f2e574 100644 --- a/docs/android/submit.md +++ b/docs/android/submit.md @@ -35,6 +35,20 @@ If you're a new contributor, each CI run must be approved by a maintainer. 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. ::: +### Update your branch + +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: + +- **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). +- **Rebase** your branch onto `main` by following the [Git rebase documentation](https://docs.github.com/en/get-started/using-git/about-git-rebase). + +Follow these guidelines: + +- If your pull request has **not** been reviewed, you can rebase or merge. +- If your pull request **has been reviewed**, use merge instead of rebase. Rebasing after review can break previous comments and remove valuable feedback. + +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. + ### Review process #### Who can review?