Contribution Guidelines

Thank you for contributing to Awesome Android Root! This guide helps you add quality entries to our collection of 500+ root apps and modules.

Quick Start

Want to add an app or module? Follow these 3 simple steps:

1. Fork & Edit

1. Fork this repository
2. Edit README.md to add your entry
3. Submit a pull request

2. Use the Correct Format

- **[App Name](link)** - Brief description of what it does. `FOSS` `[M]`

3. Follow the Rules

• ✅ App requires root access
• ✅ Working links only
• ✅ No duplicates
• ✅ Place in correct category (alphabetical order)

Entry Format

Template:

- **[⭐ App Name](primary-link)** - Description of functionality. `FOSS/Proprietary` `[M]` `[K]` `[A]` `[LSP]` | [🌱](f-droid-link) | [▶️](play-store-link)

Required Elements:

• App Name in bold with link
• Primary Link (best available source, see priority below)
• Description (1-2 sentences, focus on what it does)
• License (FOSS or Proprietary)
• Framework Tags (if applicable): [M] [K] [A] [LSP]
• Store Icons (optional): Add | [🌱](link) for F-Droid and/or | [▶️](link) for Play Store alongside the main entry

Link Priority:

1. GitHub → 2. F-Droid → 3. Official Site → 4. Play Store

Store Icon Reference:

Icon	Source
🌱	Available on F-Droid / IzzyOnDroid
▶️	Available on Google Play Store

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]`

Categories & Tags

Framework Tags

• [M] = Magisk Module (requires Magisk)
• [K] = KernelSU Module (requires KernelSU)
• [A] = APatch Module (requires APatch)
• [LSP] = LSPosed / Xposed Module (requires LSPosed)

License Tags

• FOSS = Free and Open Source Software (source code available)
• Proprietary = Closed-source software or unclear licensing

Special Badges

• ⭐ = Community recommended (widely trusted apps)

Store & Source Icons

• 🌱 = Available on F-Droid / IzzyOnDroid
• ▶️ = Available on Google Play Store

Quality Requirements

Must Have:

• ✅ App requires root access for main features
• ✅ Working links to official sources
• ✅ Updated within last 18 months
• ✅ No duplicates
• ✅ Proper category placement (alphabetical order)
• ✅ Correct format and tags

Don't Include:

• ❌ Broken/dead apps
• ❌ Malware or suspicious apps
• ❌ Non-root apps (unless in specific categories)
• ❌ Promotional language

Pull Request Template

When submitting, use this format:

### What I'm Adding
- [App Name] - Brief description
- Category: [Category Name]
- Framework: [Magisk/KernelSU/APatch/LSPosed/Root App]

### Checklist
- [ ] Tested all links
- [ ] App requires root access
- [ ] No duplicates found
- [ ] Correct format used
- [ ] Placed in right category alphabetically
- [ ] Added proper tags (license, framework, store icons)

### Links
- Primary: [Best available link]
- Source: [GitHub/GitLab if available]
- F-Droid: [F-Droid link if available]
- Play Store: [Play Store link if available]

Need Help?

Common Questions:

• Where to place my app? Look for similar apps in the categories
• What if it's both FOSS and has modules? Use multiple tags: FOSS [M] [K] [LSP]
• Can I add F-Droid or Play Store links? Yes! Add store icons after the description: | [🌱](f-droid-link) | [▶️](play-store-link)
• App works without root too? If main features need root, include it
• Unsure about tags? Check similar apps for examples
• What if an app supports multiple frameworks? List all applicable tags: [M] [K] [A]

Get Support:

• 🐛 Issues: For bugs or questions
• 💬 Discussions: For general help
• 📝 PR Comments: For specific feedback

---

Quality over quantity! One good entry is better than multiple rushed ones. Thanks for contributing!