Contributing¶
Rotorflight is an open-source community project. You don't have to be a programmer to help -- most of what keeps the project going is pilots helping pilots.
Ways to help¶
- Help other pilots on the Rotorflight Discord and forums.
- Report bugs -- with steps to reproduce them, a
diff alland a Blackbox log where relevant -- on the issue tracker of the right repository on GitHub. The issue trackers aren't for support questions; ask on Discord first. - Test development snapshots and release candidates, and report back.
- Improve these docs -- see Editing the Docs.
- Translate the Configurator and the Lua suites into your language.
- Write code for the firmware, Configurator, Blackbox Explorer or Lua suites -- see Developers.
- Support the project financially -- see Support the Project.
Flight testing¶
Testing new code is how Rotorflight gets better -- and bugs, or a misconfiguration, do happen.
Crashes are part of testing
Anyone testing development code must accept that crashing is possible.
Testers who help most have:
- a spare collective-pitch helicopter;
- good building skills, especially with electronics;
- enough flying skill to tell whether something works;
- patience, and the habit of recording Blackbox logs.
The repositories¶
| Repository | What it is |
|---|---|
| rotorflight-firmware | Flight controller firmware (C) |
| rotorflight-configurator | Configurator (Svelte/JavaScript, NW.js and web) |
| rotorflight-blackbox | Blackbox Explorer |
| rotorflight-lua-ethos-suite | Ethos Lua suite |
| rotorflight-lua-edgetx-suite | EdgeTX Lua suite (RFSuite) |
| rotorflight-lua-scripts | Classic EdgeTX/OpenTX Lua scripts |
| rotorflight-targets | Board configurations |
| rotorflight-presets | Presets shown in the Configurator |
| rotorflight-ref-design | Flight controller reference designs |
| rotorflight-documentation | This site |