New plugin checklist

Jump to bottom Edit New page

Richard Hughes edited this page Feb 9, 2021 · 3 revisions

All newly submitted plugins should have the following checklist reviewed.

Checklist

Fill out README.md with update protocol
Fill out README.md with any custom quirks and flags
Fill out README.md with the vendor ID security value
Implement FuFirmware->write() and include at least one fuzzer testcase in src/fuzzing/firmware for any custom FuFirmware subclass
CI run of the plugin for at least one target
Document targets CI isn't currently run and the reasons (i.e. minimum versions needed or distribution limitations etc).

Using the checklist

Copy and paste the above checklist into a pull request and check the boxes to indicate that the items are completed.