| bigbiff bigbiff | 5be3b23 | 2016-07-19 21:02:25 -0400 | [diff] [blame] | 1 | --- |
| 2 | layout: post |
| bigbiff bigbiff | 597e2a4 | 2018-10-16 15:52:07 -0400 | [diff] [blame] | 3 | title: "How Do I Become a TWRP Maintainer?" |
| bigbiff bigbiff | 5be3b23 | 2016-07-19 21:02:25 -0400 | [diff] [blame] | 4 | --- |
| 5 | |
| 6 | <div class='page-heading'>How Do I Become a TWRP Maintainer?</div> |
| 7 | <hr /> |
| 8 | <ol> |
| 9 | <li>Device Tree</li> |
| bigbiff | bf8053f | 2020-09-17 19:11:18 -0400 | [diff] [blame] | 10 | You need to have a device tree. You need to figure this out on your own. You can review other trees for help and modify it as necessary. You can use <a href="https://github.com/Tasssadar/libbootimg">libbootimg</a> to get the needed values from stock recovery to populate BoardConfig.mk. |
| 11 | <li>Push your tree to GitHub.com.</li> |
| 12 | We need to be able to fork your tree to our TeamWin repository. We can then add it to our Gerrit.twrp.me and Jenkins.twrp.me instance for building. If you want to be an active maintainer, we can give you +2 rights to merge new updates directly to our repository at GitHub. |
| bigbiff bigbiff | 5be3b23 | 2016-07-19 21:02:25 -0400 | [diff] [blame] | 13 | <li>Verify your device tree works</li> |
| bigbiff | fc5253a | 2020-03-22 17:14:13 -0400 | [diff] [blame] | 14 | Make sure your image works as intended. You can use the following for a functional list to test your device: |
| 15 | <pre> |
| 16 | Blocking checks |
| 17 | - [ ] Correct screen/recovery size |
| 18 | - [ ] Working Touch, screen |
| 19 | - [ ] Backup to internal/microSD |
| 20 | - [ ] Restore from internal/microSD |
| 21 | - [ ] reboot to system |
| 22 | - [ ] ADB |
| 23 | |
| 24 | Medium checks |
| 25 | - [ ] update.zip sideload |
| 26 | - [ ] UI colors (red/blue inversions) |
| 27 | - [ ] Screen goes off and on |
| 28 | - [ ] F2FS/EXT4 Support, exFAT/NTFS where supported |
| 29 | - [ ] all important partitions listed in mount/backup lists |
| 30 | - [ ] backup/restore to/from external (USB-OTG) storage (not supported by the device) |
| 31 | - [ ] backup/restore to/from adb (https://gerrit.omnirom.org/#/c/15943/) |
| 32 | - [ ] decrypt /data |
| 33 | - [ ] Correct date |
| 34 | |
| 35 | Minor checks |
| 36 | - [ ] MTP export |
| 37 | - [ ] reboot to bootloader |
| 38 | - [ ] reboot to recovery |
| 39 | - [ ] poweroff |
| 40 | - [ ] battery level |
| 41 | - [ ] temperature |
| 42 | - [ ] encrypted backups |
| 43 | - [ ] input devices via USB (USB-OTG) - keyboard, mouse and disks (not supported by the device) |
| 44 | - [ ] USB mass storage export |
| 45 | - [ ] set brightness |
| 46 | - [ ] vibrate |
| 47 | - [ ] screenshot |
| 48 | - [ ] partition SD card |
| 49 | </pre> |
| bigbiff | f6543df | 2023-05-30 20:32:15 -0400 | [diff] [blame] | 50 | <li>Use our <a href="http://tiny.cc/TWRP-Zulip">Zulip</a> to send your repository to use for official inclusion at twrp.me. Ping in support for details.</li> |