Contributing

Thank you for improving RIG-Hover. This project combines open hardware, embedded firmware, 3D printed mechanics, balance tuning, and AI interaction. Reproducible information is as important as code.

Welcome Contributions

• Fix documentation errors.

• Add assembly photos, exploded views, wiring diagrams, and print notes.

• Improve BOM details and replacement part rules.

• Share verified slicer profiles and material settings.

• Improve firmware safety protections.

• Add tuning records for different hardware revisions.

• Improve MCP tools, Web tuning UI, and developer examples.

• Submit reproducible bug reports.

Issue Report Checklist

When reporting a problem, include:

• Hardware revision.

• Printed part revision.

• Firmware branch, tag, or commit.

• Battery voltage.

• Motor model and left/right wiring.

• Whether the issue happens suspended, hand-held, or free-standing.

• Serial logs.

• Web debug values if available.

• Short video for motion or balance issues.

Pull Request Checklist

• Keep the change focused.

• Do not mix unrelated refactors.

• Update documentation when changing wiring, pins, behavior, or tuning defaults.

• Do not remove fall detection or torque cutoff logic.

• Avoid blocking work in real-time control paths.

• If modifying balance control, test on real hardware when possible.

• If modifying mechanical parts, include STL/STEP revision notes and print settings.

Documentation Style

• Prefer steps and checklists over long paragraphs.

• Put safety warnings near the risky operation.

• Use metric units.

• Keep BOM entries structured and specification-first.

• Mark prototype values as "verify with final hardware revision".

• Keep source paths and variable names exactly as they appear in firmware.

• Write for both makers and developers: explain what to do and why it matters.

Hardware Revision Notes

For hardware changes, record:

• PCB revision.

• Printed part revision.

• Motor direction convention.

• IMU mounting direction.

• Cable and connector changes.

• Pin changes.

• Firmware changes required by the hardware.

• Tuning values verified with this revision.