[Docs] Add VM testing network configuration to CONTRIBUTING.md#288
[Docs] Add VM testing network configuration to CONTRIBUTING.md#288imxade merged 5 commits intoAOSSIE-Org:mainfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughAdded VM-focused documentation: CONTRIBUTING.md now includes a "Testing Rein on a Virtual Machine" section explaining switching the VM network adapter from NAT to Bridged and selecting the host interface; README.md had a minor footer formatting change. No code or public API changes. (≤50 words) Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 258-270: Add the new "🖥 Testing Rein on a Virtual Machine"
section to the document's Table of Contents by inserting a matching TOC entry
(link) for that heading text; locate the existing TOC block and add a markdown
link with the same heading text (or its slugified anchor) so the "🖥 Testing
Rein on a Virtual Machine" section becomes navigable from the TOC.
In `@README.md`:
- Around line 65-121: Remove the full VM walkthrough under the "## 🖥 Running
Rein in a Virtual Machine" section and replace it with a short pointer to
CONTRIBUTING.md (e.g., "For contributor-focused VM networking guidance, see
CONTRIBUTING.md#-testing-rein-on-a-virtual-machine"), keeping only a one-line
note and deleting the duplicated steps (the ip a/ifconfig/ipconfig examples, npm
install/npm run dev block if already in CONTRIBUTING.md, and firewall
instructions) so the detailed instructions live in a single source of truth;
update the README heading "## 🖥 Running Rein in a Virtual Machine" to contain
only the brief pointer.
- Around line 65-103: Add the missing blank line before the "## 🖥 Running Rein
in a Virtual Machine" heading and ensure each fenced code block for the OS
commands (the "ip a", "ifconfig", and "ipconfig" blocks) is preceded and
followed by a blank line so markdownlint-cli2 no longer reports spacing errors;
update the README.md section around the "Network Configuration" and "Find the VM
IP Address" subsections to insert those blank lines around the three ```bash```
fenced blocks and the heading.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 8fa3905a-0e21-45ab-bdb8-1e4def8e2d12
📒 Files selected for processing (2)
CONTRIBUTING.mdREADME.md
| ## 🖥 Testing Rein on a Virtual Machine | ||
|
|
||
| When testing Rein inside a Virtual Machine (VirtualBox or VMware), the VM must allow devices on the same network to access the server. | ||
|
|
||
| ### Network Configuration | ||
|
|
||
| 1. Open **VM Settings** | ||
| 2. Go to **Network** | ||
| 3. Change Adapter from **NAT → Bridged Adapter** | ||
| 4. Select your active **Wi-Fi or Ethernet interface** | ||
|
|
||
| This allows devices on the same LAN to connect to the Rein server running inside the VM. | ||
|
|
There was a problem hiding this comment.
Add this section to the table of contents.
The new heading at Line 258 is not linked from the existing TOC, so the document now has a navigable section gap.
Suggested follow-up
## 📑 Table of Contents
- [How Can I Contribute?](`#how-can-i-contribute`)
- [Coding with AI](`#coding-with-ai`)
- [Getting Started](`#getting-started`)
- [Development Workflow](`#development-workflow`)
- [Pull Request Guidelines](`#pull-request-guidelines`)
- [Code Style Guidelines](`#code-style-guidelines`)
+- [Testing Rein on a Virtual Machine](`#-testing-rein-on-a-virtual-machine`)
- [Community Guidelines](`#community-guidelines`)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` around lines 258 - 270, Add the new "🖥 Testing Rein on a
Virtual Machine" section to the document's Table of Contents by inserting a
matching TOC entry (link) for that heading text; locate the existing TOC block
and add a markdown link with the same heading text (or its slugified anchor) so
the "🖥 Testing Rein on a Virtual Machine" section becomes navigable from the
TOC.
README.md
Outdated
| ## 🖥 Running Rein in a Virtual Machine | ||
|
|
||
| > Contributions are welcome! Please leave a star ⭐ to show your support. | ||
| Rein can also be tested inside a Virtual Machine such as **VirtualBox** or **VMware**. This is useful for developers who want to test the application in an isolated environment. | ||
|
|
||
| ### Network Configuration | ||
|
|
||
| To allow your phone or tablet to connect to Rein running inside the VM, you must use **Bridged Networking**. | ||
|
|
||
| Steps: | ||
|
|
||
| 1. Open **VM Settings** | ||
| 2. Go to **Network** | ||
| 3. Change Adapter Type from **NAT → Bridged Adapter** | ||
| 4. Select your active **Wi-Fi / Ethernet interface** | ||
|
|
||
| ### Start Rein Inside the VM | ||
|
|
||
| Run the following commands inside the virtual machine: | ||
|
|
||
| ```bash | ||
| npm install | ||
| npm run dev | ||
| ``` | ||
|
|
||
| ### Find the VM IP Address | ||
|
|
||
| Linux: | ||
| ```bash | ||
| ip a | ||
| ``` | ||
| macOS: | ||
| ```bash | ||
| ifconfig | ||
| ``` | ||
| Windows: | ||
|
|
||
| ```bash | ||
| ipconfig | ||
| ``` | ||
|
|
||
| ### Connect From Your Phone | ||
|
|
||
| Open this address on your phone browser: | ||
|
|
||
| `http://<VM_IP>:3000` | ||
|
|
||
| Example: | ||
|
|
||
| `http://192.168.1.45:3000` | ||
|
|
||
| ### Firewall | ||
|
|
||
| If the connection fails, ensure that **port 3000** is allowed in the VM firewall. | ||
|
|
||
| --- | ||
|
|
||
| Contributions are welcome! Please leave a star ⭐ to show your support. |
There was a problem hiding this comment.
Keep VM testing guidance in one place.
This reintroduces a full VM walkthrough in README.md, which conflicts with the stated move to CONTRIBUTING.md and creates two sources of truth for the same workflow. Please keep the detailed VM testing instructions in one document and replace this with a short pointer if needed.
Suggested simplification
-## 🖥 Running Rein in a Virtual Machine
-
-Rein can also be tested inside a Virtual Machine such as **VirtualBox** or **VMware**. This is useful for developers who want to test the application in an isolated environment.
-
-### Network Configuration
-
-To allow your phone or tablet to connect to Rein running inside the VM, you must use **Bridged Networking**.
-
-Steps:
-
-1. Open **VM Settings**
-2. Go to **Network**
-3. Change Adapter Type from **NAT → Bridged Adapter**
-4. Select your active **Wi-Fi / Ethernet interface**
-
-### Start Rein Inside the VM
-
-Run the following commands inside the virtual machine:
-
-```bash
-npm install
-npm run dev
-```
-
-### Find the VM IP Address
-
-Linux:
-```bash
-ip a
-```
-macOS:
-```bash
-ifconfig
-```
-Windows:
-
-```bash
-ipconfig
-```
-
-### Connect From Your Phone
-
-Open this address on your phone browser:
-
-`http://<VM_IP>:3000`
-
-Example:
-
-`http://192.168.1.45:3000`
-
-### Firewall
-
-If the connection fails, ensure that **port 3000** is allowed in the VM firewall.
+## 🖥 Running Rein in a Virtual Machine
+
+For contributor-focused VM networking guidance, see
+[`CONTRIBUTING.md`](CONTRIBUTING.md#-testing-rein-on-a-virtual-machine).🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 65-65: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 92-92: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 94-94: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 96-96: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 98-98: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 65 - 121, Remove the full VM walkthrough under the
"## 🖥 Running Rein in a Virtual Machine" section and replace it with a short
pointer to CONTRIBUTING.md (e.g., "For contributor-focused VM networking
guidance, see CONTRIBUTING.md#-testing-rein-on-a-virtual-machine"), keeping only
a one-line note and deleting the duplicated steps (the ip a/ifconfig/ipconfig
examples, npm install/npm run dev block if already in CONTRIBUTING.md, and
firewall instructions) so the detailed instructions live in a single source of
truth; update the README heading "## 🖥 Running Rein in a Virtual Machine" to
contain only the brief pointer.
|
Hi! I updated PR #288 according to the maintainer feedback.
Please let me know if any further changes are required. Thank you! |
2 participants
Addressed Issues:
Related to #107
Description
This PR adds a VM testing section in CONTRIBUTING.md describing how to configure Bridged Networking when running Rein inside a Virtual Machine (VirtualBox or VMware).
The section explains how to switch the VM network adapter from NAT → Bridged Adapter so devices on the same LAN can connect to the Rein server running inside the VM.
This follows the maintainer suggestion to move the VM testing instructions from README to CONTRIBUTING.md and only include the network configuration part.
Screenshots/Recordings:
Not applicable — this PR only updates documentation.
Functional Verification
Not applicable — this PR only updates documentation.
Checklist
My PR addresses a single issue or improvement.
My code follows the project's code style and conventions
I have performed a self-review of my own code
I have made corresponding changes or additions to the documentation
My changes generate no new warnings or errors
I have joined the Discord and I will share a link to this PR with the project maintainers there
Once I submit my PR, CodeRabbit AI will automatically review it and I will address CodeRabbit's comments if any.
Summary by CodeRabbit