Contribution Guidelines

Thank you for helping maintain Awesome Android Root. Contributions include new resources, corrections, and documentation updates.

Add an app or module

1. Fork the repository and edit the relevant topic page in docs/apps-and-modules/. These category files are the collection's source of truth; the root README.md is an index.
2. Place each entry in one category that matches its main function. If the current categories do not fit, open a taxonomy issue before reorganizing the collection.
3. Follow the entry format and quality checklist below, then submit a pull request.

Entry format

Use this pattern:

- **[⭐ App Name](primary-source-link)** - Briefly describe what it does. `FOSS` `[M]` | [🌱](f-droid-link) | [▶️](play-store-link)

Include:

• The app or module name linked to its best available source.
• A concise, factual 1-2 sentence description of its main function.
• One license badge: FOSS or Proprietary.
• Every applicable framework badge: [M] Magisk, [K] KernelSU, [A] APatch, or [LSP] LSPosed/Xposed.
• Optional store links after the badges: 🌱 for F-Droid/IzzyOnDroid and ▶️ for Google Play.

Prefer links in this order: GitHub, F-Droid, official project site, then Google Play. Use a direct project or release page when one exists.

Examples

- **[⭐ AdAway](https://github.com/AdAway/AdAway)** - Open-source ad blocker using the hosts file. Blocks ads without permissions. `FOSS` | [🌱](https://f-droid.org/packages/org.adaway)
- **[Zygisk Detach](https://github.com/j-hc/zygisk-detach)** - Detach apps from Play Store to prevent updates. `FOSS` `[M]`
- **[Magisk](https://github.com/topjohnwu/Magisk)** - Systemless root solution with module support. `FOSS`
- **[CorePatch](https://github.com/LSPosed/CorePatch)** - Disable signature verification for Android. `FOSS` `[LSP]`
- **[bindhosts](https://github.com/bindhosts/bindhosts)** - Systemless hosts for APatch, KernelSU and Magisk. `FOSS` `[M]` `[K]` `[A]`

Badges

Badge	Meaning
FOSS	Free and open-source software.
Proprietary	Closed-source software or licensing that is unclear.
[M]	Magisk module.
[K]	KernelSU module.
[A]	APatch module.
[LSP]	LSPosed/Xposed module.
⭐	Community-recommended entry; reserve it for widely trusted resources.
🌱	F-Droid or IzzyOnDroid listing.
▶️	Google Play listing.

Quality checklist

• Confirm the source link works and points to the project, not an unrelated mirror.
• Keep the description factual, concise, and free of promotional claims.
• Avoid duplicate entries and place the resource alphabetically in its category; starred entries come first.
• Confirm the resource was updated within the last 18 months, as required by the project.
• State relevant compatibility and access requirements. Root-specific apps and modules belong here; non-root tools are appropriate only when they clearly fit an established category. If root, ADB, Shizuku, or a particular framework is required, make that clear in the description or badges.
• Do not submit broken, malicious, or suspicious software.

Other contributions

For guide changes, preserve prerequisites, warnings, commands, exceptions, and recovery instructions. Link to an existing canonical guide rather than duplicating long procedures where possible.

Before submitting, review the pull request template. Ask questions in GitHub Issues, Discussions, or the pull request itself.