Contribution Guidelines
Thank you for contributing to Awesome Android Root! This guide helps you add quality entries to our collection of 400+ root apps and modules.
Quick Start
Want to add an app or module? Follow these 3 simple steps:
1. Fork & Edit
- Fork this repository
- Edit
README.mdto add your entry - Submit a pull request
2. Use the Correct Format
markdown
- **[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:
markdown
- **[App Name](primary-link)** - Description of functionality. `FOSS/Proprietary` `[M]` `[K]` `[LSP]`Required Elements:
- App Name in bold with link
- Primary Link (best available source)
- Description (1-2 sentences, focus on what it does)
- License (
FOSSorProprietary) - Framework Tags (if applicable):
[M][K][LSP]
Link Priority:
- F-Droid → 2. GitHub → 3. Official Site → 4. Play Store
Examples:
markdown
- **⭐ [AdAway](https://f-droid.org/packages/org.adaway/)** - System-wide ad blocker using hosts file. `FOSS`
- **[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`Categories & Tags
Framework Tags
[M]= Magisk Module[K]= KernelSU Module[LSP]= LSPosed/Xposed Module
License Tags
FOSS= Open source (source code available)Proprietary= Closed source
Special Badges
- ⭐ = Community recommended (widely trusted apps)
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/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
### Links
- Primary: [Best available link]
- Source: [GitHub/GitLab 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][LSP] - App works without root too? If main features need root, include it
- Unsure about tags? Check similar apps for examples
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!