Skip to content

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 โ€‹

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 (FOSS or Proprietary)
  • Framework Tags (if applicable): [M] [K] [LSP]

Link Priority:

  1. 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!