Requirements for the Submission of New and Updated Targets
Pull requests adding new targets or modifying existing targets need to meet the following requirements:
-
Hardware should follow the Manufacturer Design Guidelines. The config repository carries designs that the Betaflight team has reviewed and accepted. A new design that uses anything not accepted for new designs in the Hardware Policy is not accepted, anything not recommended is accepted only within its limits, and one that copies an existing design is not eligible for Betaflight Supported. A manufacturer remains free to distribute their own firmware for any design, see Two Routes to Pilots. To avoid costly issues and delays, please talk to the Betaflight team early in the design process.
-
New manufacturers are required to be added to the manufacturers list. Your four-letter manufacturer ID is also the name of the directory your configs live in, so it must be registered before the first target is submitted. Submissions that have no registered vendor use one of the reserved IDs already in that list (
CUST,FOSS,COMM,LEGA) and need no new entry. -
For any new targets, a definition file needs to be submitted to betaflight/config, placed at
configs/<MANUFACTURER_ID>/<BOARD_NAME>/config.h. Board names must be unique across the whole repository. See the instructions for how to create a configuration file. Ensure you adhere to the Config Target Guidance also. -
For changes to existing targets, the existing definition configuration file must be updated in the Betaflight Config repository.
-
Pull requests to the config repository must be raised from a custom branch, not from
master. Pull requests frommasterare closed automatically. -
Upon approval and merging, you must add board documentation as per documentation guidelines.