Contributing

This chapter aims to give tips to first time vexide contributors. If you want to contribute to vexide, make sure you join the discord server! For info on contributing guidelines, please read CONTRIBUTING.md in the vexide repository.

Note

All development on pros-rs has stopped. We are now solely developing and maintaining vexide.

Project structure

Because vexide is split into multiple crates and multiple repositories, finding the part of vexide you want to work on can be a little overwhelming. To hopefully make it easier to find what you are looking for, here is a simple graph of the project structure:

• vexide
  • packages
    • vexide
    • vexide-async
    • vexide-core
    • vexide-devices
    • vexide-macro
    • vexide-math
    • vexide-panic
    • vexide-startup
• pros-rs
  • packages
    • pros
    • pros-sys
    • pros-async
    • pros-core
    • pros-devices
    • pros-math
    • pros-panic
    • pros-sync
• cargo-pros (vexide build tooling with the cargo pros command)
• pros-simulator
  • packages
    • pros-simulator (WASM simulator backend)
    • pros-simulator-interface
    • pros-simulator-server (Standalone wrapper over the wasm backend)
• vex-v5-sim (WIP QEMU simulator backend)
• internal-documentation (This website)
• website (Our main page)