Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.22 KB

File metadata and controls

49 lines (30 loc) · 2.22 KB

Contributing to SysctlGUI

First off, thank you for considering contributing to SysctlGUI! Your help is greatly appreciated. Whether it's reporting a bug, discussing improvements, or contributing code, every bit of effort makes this project better.

This document provides a set of guidelines for contributing to SysctlGUI. These are mostly guidelines, not strict rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

There are many ways to contribute, and we welcome them all!

Reporting Bugs

If you find a bug, please make sure it hasn't already been reported by searching the GitHub Issues.

When you are creating a bug report, please include as many details as possible:

  • A clear and descriptive title for the issue
  • Steps to reproduce the bug in a clear, step-by-step list
  • Describe the expected behavior and what you observed instead
  • Provide details about your environment:
    • App version
    • Android version and ROM (e.g., Android 13, LineageOS 20)
    • Device model
    • Root solution (e.g., Magisk, KernelSU)
  • Include logs (like a Logcat) or screenshots if they are relevant

Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing one, please open an issue to start a discussion.

  • Use a clear and descriptive title for the issue
  • Provide a detailed description of the enhancement and why it would be useful
  • Explain the problem it solves or the workflow it improves
  • Include mockups or screenshots if they help illustrate your idea

Pull Requests

Code contributions are always welcome. If you can contribute with code, please do so.

Translations

If you are fluent in another language, your help with translations would be invaluable. Please see the translation guide for detailed instructions on how to contribute translations.

License

By contributing to SysctlGUI, you agree that your contributions will be licensed under the License that covers the project.