21 lines
923 B
Markdown
21 lines
923 B
Markdown
# 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:
|
||
|
||
```bash
|
||
# 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.
|
||
Review and Diagnostics export raw run data; Settings › Privacy provides a separate redacted export.
|
||
See [Export runs for agent review](docs/run-data-export.md), and check archives before attaching them to an issue.
|
||
|
||
Code under `hardware/hid_bridge/src/airplay/` is GPL-3.0 (ported from UxPlay); contributions there are GPL-3.0 too.
|