Files
esp32-iphone-agent/CONTRIBUTING.md
T
HenryandClaude Opus 5.5 e035e424f4 docs, CI: README for the no-computer version, legacy notes, app + firmware CI
server/ stays as the legacy v0.1.0 setup (tag v0.1.0, branch legacy).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 09:55:35 +08:00

796 B

Contributing

Issues and pull requests are welcome. Keep changes small and focused, and match the surrounding code.

Before sending a change, run the checks for what you touched:

# app (Xcode 26+)
cd ios && xcodegen && xcodebuild test -scheme IPhoneAgent -destination 'platform=iOS Simulator,name=iPhone 17 Pro'
# firmware
hardware/flash.sh --build-only && make -C hardware/tests
# legacy server
cd server && pip install -e ".[dev]" && ruff check . && pytest

Never commit secrets: ios/Config/Local.xcconfig and hardware/hid_bridge/secrets.h are git-ignored on purpose. Run data exported from the app is redacted, but check it before attaching it to an issue.

Code under hardware/hid_bridge/src/airplay/ is GPL-3.0 (ported from UxPlay); contributions there are GPL-3.0 too.