2.0 KiB
2.0 KiB
Contributing to runaway
Thank you for considering contributing to runaway! This document outlines the guidelines for contributions.
Code of Conduct
This project follows a Code of Conduct. By participating, you agree to uphold it.
How to Contribute
Reporting Issues
- Bug reports: Open an issue with the
buglabel. Include macOS version, hardware (Intel/Apple Silicon), and steps to reproduce. - Feature requests: Open an issue with the
enhancementlabel. Describe the problem and the proposed solution. - Compatibility reports: Open an issue with the
compatibilitylabel if you've tested on a new macOS version or hardware.
Pull Requests
- Fork the repository
- Create a feature branch from
main - Follow the existing code style (ShellCheck compliant)
- Test your changes:
- Syntax check:
bash -n lib/*.sh runaway - ShellCheck:
shellcheck lib/*.sh runaway(install viabrew install shellcheck)
- Syntax check:
- Update documentation (README.md) if adding features
- Open a PR against
main
Code Style
- Shell: Bash 3.2+ compatible (macOS default)
- Naming: Functions →
snake_case, Constants →UPPER_CASE - Error handling: Use
set -euo pipefailin the main script - Library functions: Return 0 on success, call
error_exiton failure - Portability: Avoid GNU-specific flags; prefer macOS-compatible options
Testing
- Manual testing is required for now
- Preferred environments: macOS Recovery mode (Intel and Apple Silicon)
- Test both
bypass(from Recovery) andsuppress/heal(from booted system)
Areas Needing Help
- New macOS version compatibility: Test on latest macOS releases
- Additional MDM domains: Research and add new Apple MDM endpoints
- Firewall improvements: Better pf rules for selective blocking
- Documentation: Translations, better troubleshooting guides
- CI/CD: Actions-based CI for automated ShellCheck and syntax validation
Questions?
Open a discussion or issue. We aim to respond within 48 hours.