Contributing to Awesome KernelSU

July 20, 2025 · View on GitHub

Thank you for your interest in contributing to Awesome KernelSU! This guide will help you understand how to contribute effectively to this curated list.

Table of Contents

Contributing Guidelines

What Can You Contribute?

  • Official Resources: New official KernelSU tools, documentation, or announcements
  • KernelSU Derivatives: Forks like KernelSU-Next, SuKiSu-Ultra, or new derivatives
  • Modules: High-quality KernelSU modules that provide useful functionality
  • Tools: Development tools, builders, or utilities related to KernelSU
  • Documentation: Tutorials, guides, or educational content
  • Community Resources: Forums, communities, or discussion platforms
  • Related Projects: Projects that complement or work with KernelSU

What We Don't Accept

  • Outdated Projects: Resources not updated in the last 6 months
  • Malicious Content: Anything that could harm users or devices
  • Commercial Promotions: Pure advertising without educational value
  • Duplicate Entries: Resources already listed in the same section
  • Broken Links: Non-functional or redirecting links
  • Low-Quality Resources: Poorly documented or unreliable projects

Resource Quality Standards

Required Information

Each entry should include:

  1. Clear Title: Descriptive name of the resource
  2. Working Link: Direct link to the official source
  3. Brief Description: Concise explanation of what it does
  4. Relevance Indicators: Stars, downloads, or activity metrics where applicable

Format Standards

Basic Format

- [**Resource Name**](https://github.com/user/repo) - Clear description of what it does
  1. Primary: Official GitHub repository
  2. Secondary: Official project website
  3. Tertiary: Official documentation
  4. Last Resort: Trusted community mirrors

How to Submit

Step 1: Fork the Repository

git clone https://github.com/your-username/awesome-kernelsu.git
cd awesome-kernelsu

Step 2: Create a Branch

git checkout -b add-new-resource

Step 3: Make Your Changes

  1. Find the appropriate section in README.md
  2. Add your resource following the format standards
  3. Maintain alphabetical order within subsections
  4. Ensure all links work and point to official sources

Step 4: Test Your Changes

  • Check all links are functional
  • Verify formatting is consistent
  • Ensure descriptions are accurate and helpful
  • Test that the resource actually works with KernelSU

Step 5: Submit Pull Request

git add README.md
git commit -m "Add [Resource Name] to [Section Name]"
git push origin add-new-resource

Create a pull request with:

  • Clear Title: "Add [Resource Name] to [Section]"
  • Description: Explain why this resource is valuable
  • Testing: Confirm you've tested the resource
  • Quality: Verify it meets our standards

Review Process

What We Check

  1. Functionality: Does the resource work as described?
  2. Quality: Is it well-maintained and documented?
  3. Relevance: Does it provide value to KernelSU users?
  4. Uniqueness: Is it already covered by existing entries?
  5. Standards: Does it follow our formatting guidelines?

Review Timeline

  • Initial Review: Within 48 hours
  • Feedback: If changes needed, expect detailed feedback
  • Approval: Once all criteria are met
  • Merge: Usually within 24 hours of approval

Possible Outcomes

  • ✅ Approved: Resource meets all standards
  • 📝 Needs Changes: Minor adjustments required
  • ❌ Rejected: Doesn't meet quality standards
  • 🔄 Deferred: Good resource, wrong timing

Maintenance

Keeping Resources Current

We regularly review all resources for:

  • Link Health: Ensuring all links remain functional
  • Project Activity: Removing abandoned or outdated resources
  • Information Accuracy: Updating descriptions and metrics
  • New Categories: Adding sections for emerging trends

Reporting Issues

If you find:

  • Broken links
  • Outdated information
  • Inappropriate content
  • Missing important resources

Please open an issue or submit a pull request.

Community Maintenance

Help us keep this list valuable by:

  1. Monitoring: Watch for changes in listed projects
  2. Updating: Submit PRs to update outdated information
  3. Suggesting: Recommend new high-quality resources
  4. Quality Control: Report low-quality or problematic entries

Special Considerations

KernelSU Derivatives

When adding derivatives:

  • Clearly explain differences from main KernelSU
  • Include compatibility information
  • Note any unique features or limitations
  • Verify active development and community support

Modules

For KernelSU modules:

  • Confirm compatibility with current KernelSU versions
  • Include brief functionality description
  • Note any special requirements or dependencies
  • Verify the module is safe and well-tested

Documentation

For tutorials and guides:

  • Ensure accuracy and current best practices
  • Verify compatibility with latest KernelSU versions
  • Include difficulty level (beginner/advanced)
  • Check that instructions are complete and clear

Questions?

If you have questions about contributing:

  1. Check existing issues
  2. Review similar pull requests
  3. Ask in the KernelSU community
  4. Open a new issue for clarification

Thank you for helping make Awesome KernelSU the best resource for the community! 🚀

Every contribution, no matter how small, helps make the KernelSU ecosystem stronger.