Thank you for your interest in contributing.
Please read the README first to understand the project scope, features, and current direction.
You can contribute in the following ways:
- report bugs
- suggest features
- improve documentation
- fix issues
- improve tests and code quality
When opening a bug report, include:
- macOS version
- MacOSCleaner version or commit
- device type (Apple Silicon or Intel)
- steps to reproduce
- expected result
- actual result
- screenshots or logs if available
Keep reports focused on one issue only.
For feature requests, describe:
- the problem you want to solve
- why the feature is useful
- possible behavior or workflow
- any limitations or edge cases
Before opening a pull request:
- make sure the change is small and focused
- check that the code builds locally
- update documentation if needed
- avoid unrelated refactors in the same PR
- keep code simple and readable
- follow the existing project style
- use English for code comments
- keep commit messages clear and descriptive
Please avoid changes that are unrelated to the project goals. If a larger change is needed, open an issue first.
Maintainers may ask for changes before merging. Please respond to review comments directly in the PR.
Do not open security issues as public bugs. Use the security channel or repository security contact if available.