Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (40 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

73 lines (40 loc) · 3 KB
Raw

Contributing

Thank you for your interest in contributing to Apex! Apex is an Android application built with Kotlin and Jetpack Compose designed for cache cleaning, storage management, and RAM optimization.

Before submitting a bug report or feature request, please search existing issues (including closed ones) to ensure it hasn't already been reported or discussed. If there are no duplicates, feel free to submit a new issue using the appropriate template.

Please note: Issues that do not use existing templates or lack sufficient detail may be closed without review.

For questions or any other ideas to improve, you can join our official e-mail : hamzabellouchcontact@gmail.com or Social Medial platforms.

Disclaimer

Apex is an active Android project focused on providing a clean, efficient, and private storage management tool. While we strive for code quality and reliability, contributions and feedback are always welcome to improve performance and user experience.

Bug Reports

When submitting a bug report, please make sure your issue contains sufficient information to reproduce the problem. Useful details include:

  • Device model and Android version
  • Apex app version
  • Granted permission states (Usage Access, Accessibility Service)
  • Steps to reproduce the bug
  • System logs (logcat) or screenshots if applicable

Feature Requests

Apex aims to remain a fast, privacy-focused, and lightweight system utility for Android. We welcome suggestions that enhance user experience, UI responsiveness, or storage management capabilities.

When suggesting a new feature, please consider:

  • Relevance: Does the feature fit the core goal of cache cleaning and memory optimization?
  • Privacy & Safety: Does it preserve on-device processing and user privacy without requiring unsafe permissions?
  • Simplicity: We prefer clean, intuitive features over overly complex options that bloat the user interface.

Pull Requests

If you wish to contribute directly by submitting code:

  1. Discuss First: Leave a comment under an existing issue or open a new issue describing the changes you plan to make before writing code.
  2. Avoid Conflicts: Comment on the issue to let others know you are working on it to prevent duplicate efforts.
  3. Follow Code Style: Ensure your code follows modern Kotlin conventions and Jetpack Compose best practices.

New Contributors

If you are new to the project:

  • Browse our open issues for beginner-friendly tasks marked as good first issue or help wanted.
  • Feel free to ask clarifying questions directly on the issue thread!

Building From Source

To build Apex locally:

  1. Prerequisites:

    • Android Studio (latest stable or preview release)
    • JDK 17 or higher
    • Android SDK API Level 34+

  2. Steps:

    # Clone the repository
git clone https://github.com/hamzabellouch/apex.git

# Open the project in Android Studio and sync Gradle files