Skip to content

Latest commit

 

History

History
100 lines (76 loc) · 3.93 KB

maintain.md

File metadata and controls

100 lines (76 loc) · 3.93 KB
Raw

About

You want to become an official maintainer of a device? Good! Then this guide is for you!

Before starting you should have read the Build Guide and so having a working port for the device you want to maintain.

Another hard requirement is the use of Telegram: it's free, available on all platforms and nice so have that installed before doing anything else.

Steps

Join the main SHRP Telegram groups

  1. SHRP community
  2. SHRP releases

Build

  • Read and follow the Build Guide
  • Build locally on your pc and test with at least 1 or 2 other users (the more the better of course).
  • Do not proceed until you have a fully working build (see next topic) - if needed ask for help in SHRP community

Requirements

Mandatory

The following are hard requirements in order to make you a maintainer of a device and adding your device to official builds:

  1. You must own the device. We don't accept blind builds!
  2. Test normal operations - at least these:
    • full backup of all partitions
    • full restore of all partitions
    • execute a factory reset
    • mount/unmount partitions manually
    • flash a ROM
    • Test the file manager
    • Test the terminal app
  3. Theme - at least these:
    • Change theme color
    • Change dashboard icons
  4. Change SHRP to another language
  5. ADB sideload must work
  6. Security:
    • set pattern lock, reboot, test if ADB + MTP is NOT accessible, unlock, test if ADB + MTP is accessible now
    • set password lock, reboot, test if ADB + MTP is NOT accessible, unlock, test if ADB + MTP is accessible now
  7. Magisk:
    • install by the SHRP menu
    • boot to Android twice (if magisk manager do not show up on the first boot)
    • check magisk manager - was rooting succesful?
    • UnRoot in SHRP
    • boot to Android - Magisk / root really gone?
  8. Decrypting* (custom ROMs like LOS etc)
  9. Test an external sdcard (obviously for devices with an external sdcard slot only)
    • must have: vFAT and/or exFAT support (tech details)
    • nice to have: ntfs, ext2/3/4, f2fs support

' * as long as your STOCK ROM generally supports encryption. Decryption support is focused on custom ROMs only while having it working for STOCK gives you a bonus ;)

Optional

  1. Flashlight
  2. Decrypting* (STOCK)
  3. OTG support
  4. SHRP_EXPRESS

' * as long as your STOCK ROM generally supports encryption. If not you can skip that step but let us know about it.

Formals

If you walked through all the above CONGRATS!! Great job :) Now let's go on with making it real!

Fill out this little request form to request becoming a maintainer.

Request access (TG group)

  1. In SHRP community let the SHRP team know that you filled out the form (use the @ before the nickname to notify)
  2. In SHRP community request access to become a member of the maintainers Telegram group (you will be invited then).

Request access (github)

In the maintainers TG group request access to the device-tree repo if not given already.

Upload your tree(s)

Import your device tree to the device-tree repo

CI automation scripts

Add a new CI script for your device by

  • forking this CI repo
  • adding your own script: filename = device codename
  • and finally create a pull request for that change

Post your build

  • In the maintainers TG group write /get post to get the TG post template.
  • Fill out that template and post it back in the TG group