Add instructions regarding merging vs rebase (Android) #2732
Conversation
📝 WalkthroughWalkthroughA new section was added to the contribution guidelines, detailing how to update a branch that has fallen behind the main branch. It explains both merging and rebasing methods, clarifies project policies regarding their use, and provides rationale for these guidelines. Changes
Estimated code review effort1 (~2 minutes) 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/android/submit.md (2)
40-43: Add concrete Git commands for clarityReaders—especially less-experienced contributors—often look for copy-pasteable commands. Consider adding a small code block that shows the canonical commands for both approaches, e.g.:
+#### Merge +```bash +git fetch upstream +git checkout my-feature +git merge upstream/main +``` + +#### Rebase +```bash +git fetch upstream +git checkout my-feature +git rebase upstream/main +```This makes the guidelines instantly actionable while still keeping them concise.
44-44: Replace the long GitHub Docs URL with its canonical formThe current link contains tracking/query parameters (
versionId=…&productId=…&restPage=…) that make the URL brittle and harder to diff in future edits. Use the cleaner canonical URL instead:-https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges?versionId=free-pro-team%40latest&productId=get-started&restPage=using-git%2Cabout-git-rebase#squash-and-merge-your-commits +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
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
docs/android/submit.md(1 hunks)
I did rework the text if you can double check. |
Proposed change
From this discussion it came out that we never explicitly specify our position regarding merge vs rebase in pull request. This PR add some clarification regarding the practice we follow.
Type of change
Checklist
Summary by CodeRabbit