docs: update contributing.md to include bundle install#7052
docs: update contributing.md to include bundle install#7052joseanemsilva wants to merge 2 commits intoRocketChat:developfrom
Conversation
WalkthroughAdds a single documentation step to CONTRIBUTING.md: insert "bundle install" into the Run the app setup sequence after changing into the project directory. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📝 Coding Plan
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. Comment Tip CodeRabbit can approve the review once all CodeRabbit's comments are resolved.Enable the |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
20-20: Consider adding a brief explanation for clarity.While the addition of
bundle installis correct for iOS setup, new contributors unfamiliar with Ruby/Bundler might benefit from a brief inline comment explaining why this step is needed.📝 Optional: Add explanatory comment
cd Rocket.Chat.ReactNative -bundle install +bundle install # Installs CocoaPods and other Ruby dependencies needed for iOS yarn🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 20, Add a short inline explanation adjacent to the existing bundle install line that notes this runs Bundler to install required Ruby gems (e.g., for CocoaPods or iOS tooling) so contributors without Ruby/Bundler experience understand why it's necessary; update the CONTRIBUTING.md entry for the iOS setup to include one sentence like “Run bundle install to install the Ruby gems (Bundler) required for CocoaPods and other iOS build tools.”
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@CONTRIBUTING.md`:
- Line 20: Add a short inline explanation adjacent to the existing bundle
install line that notes this runs Bundler to install required Ruby gems (e.g.,
for CocoaPods or iOS tooling) so contributors without Ruby/Bundler experience
understand why it's necessary; update the CONTRIBUTING.md entry for the iOS
setup to include one sentence like “Run bundle install to install the Ruby gems
(Bundler) required for CocoaPods and other iOS build tools.”
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0eb1e43a-3d02-4183-8b8a-b7dbb947d905
📒 Files selected for processing (1)
CONTRIBUTING.md
📜 Review details
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2026-02-05T13:55:06.688Z
Learnt from: Rohit3523
Repo: RocketChat/Rocket.Chat.ReactNative PR: 6930
File: package.json:101-101
Timestamp: 2026-02-05T13:55:06.688Z
Learning: The RocketChat/Rocket.Chat.ReactNative repository uses a fork of react-native-image-crop-picker (RocketChat/react-native-image-crop-picker) with custom Android edge-to-edge fixes, not the upstream ivpusic/react-native-image-crop-picker package. Dependencies should reference commit pins from the RocketChat fork.
Applied to files:
CONTRIBUTING.md
📚 Learning: 2026-02-27T13:18:30.658Z
Learnt from: Rohit3523
Repo: RocketChat/Rocket.Chat.ReactNative PR: 7008
File: scripts/create-avd.sh:39-44
Timestamp: 2026-02-27T13:18:30.658Z
Learning: The `scripts/create-avd.sh` script in the RocketChat/Rocket.Chat.ReactNative repository is not used in CI environments to create emulators. It's only used locally, and it's acceptable for it to error if the AVD already exists.
Applied to files:
CONTRIBUTING.md
🔇 Additional comments (1)
CONTRIBUTING.md (1)
20-20: This change is valid. The repository contains a Gemfile with required iOS dependencies (cocoapods, fastlane, etc.), confirming thatbundle installis the appropriate setup step.
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
23-34: Consider adding explicit platform labels for clarity.The addition of
bundle installis correct and properly placed beforeyarn pod-install. The "or" separator does imply that the first code block is for iOS and the second is for Android. However, adding explicit labels like "For iOS:" and "For Android:" would make this clearer for new contributors, which aligns with your PR's goal of improving the setup experience.📝 Optional enhancement for clarity
Run the app: + +For iOS: ```sh bundle install yarn pod-install yarn ios-or
+For Android:yarn android</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@CONTRIBUTING.mdaround lines 23 - 34, Update the "Run the app" section to
add explicit platform labels: prepend "For iOS:" above the block with "bundle
install", "yarn pod-install", and "yarn ios", and prepend "For Android:" above
the block with "yarn android" so contributors immediately know which block is
for which platform.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In@CONTRIBUTING.md:
- Around line 23-34: Update the "Run the app" section to add explicit platform
labels: prepend "For iOS:" above the block with "bundle install", "yarn
pod-install", and "yarn ios", and prepend "For Android:" above the block with
"yarn android" so contributors immediately know which block is for which
platform.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Organization UI **Review profile**: CHILL **Plan**: Pro **Run ID**: `4bcb417f-c4d0-4681-a149-0239ccb0e1d8` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 5242004ab7ad06178620908629a5f46de03a3109 and e8923ea39a1849a51159f0bdc3d45ebe41fe7b88. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `CONTRIBUTING.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Proposed changes
Include
bundle installin the setup instructionsIssue(s)
The setup instructions does not include the
bundle install, so new contributors might find errors when trying to run the application.yarn pod-installrequires CocoaPods, which is installed via bundle.How to test or reproduce
Setup a fresh install and follow the contributing.md instructions.
Screenshots
Types of changes
Checklist
Further comments
Summary by CodeRabbit