Thanks for helping improve Waypoint. Bug reports, device compatibility results, documentation fixes, and focused pull requests are welcome.
By participating, you agree to follow the Code of Conduct.
- Read the README, support guide, and existing issues.
- Use the private process in SECURITY.md for vulnerabilities.
- Use the appropriate issue form for bugs, compatibility results, or features.
Caution
Never upload or paste a .mobiledevicepairing file, pairing-record contents,
Apple credentials, signing credentials, device tokens, or unredacted logs.
Pairing records are trusted device credentials, not ordinary diagnostics.
Waypoint requires a Mac with Xcode 26 and
XcodeGen. The Xcode project and the
location-enabled idevice binary are generated or fetched locally:
bash scripts/fetch-idevice.sh
xcodegen generate
open Waypoint.xcodeprojDo not commit the generated Waypoint.xcodeproj, build output, IPA files,
downloaded vendor binaries, or any device-specific pairing material.
- Create a branch from the current
mainbranch. - Keep the change focused and follow the existing Swift and SwiftUI style.
- Preserve the app's clear disclosure that locations are software-simulated; Waypoint does not attempt to hide simulation from other apps.
- Update documentation when behavior, requirements, or setup changes.
- Open a pull request using the repository template.
Waypoint uses Conventional Commits with a required scope:
<type>(<scope>): <description>
Use feat, fix, refactor, perf, test, docs, build, ci, chore,
or revert as the type. Choose a concise lowercase scope that identifies the
affected area, such as map, spoofing, cellular, notifications,
onboarding, codemagic, release, or readme. Keep the description
lowercase, imperative, and without a trailing period.
Examples:
feat(map): add search result previews
fix(cellular): restore spoofing after reconnect
ci(codemagic): trigger builds from a release tag
docs(readme): clarify first-run setup
Mark breaking changes with ! before the colon and explain them in a
BREAKING CHANGE: footer.
At minimum, ensure the unsigned archive builds with Xcode 26. GitHub Actions runs this check for every pull request.
For changes that affect device behavior, report which of these you tested:
- Start, move, and stop on Wi-Fi
- Guided start on cellular data with Wi-Fi off
- First-run pairing and LocalDevVPN setup
- Backgrounding, notification permission, and connection interruption
- Relaunch or remount behavior after an iPhone restart
Physical-device testing is valuable but not required to propose a change. If it was not available, say so clearly in the pull request.
Contributions are submitted under the repository's GNU Affero General Public License v3.0. Identify any third-party code or assets and include all required attribution and license notices.