Contributing to kinhin

kinhin is built by one developer, and bug reports, feature requests and pull requests are welcome on GitHub. Not writing code? You can also add your project to Who uses kinhin or support the project.

Before you open a PR

swift build and swift test need no VMs or network. Follow the conventions in CONTRIBUTING.md: no print statements in KinhinKit or the app, errors are thrown, logging goes through Log, and access control is internal unless explicitly needed.

swift format format -i -r Sources Tests
swift format lint --strict -r Sources Tests
swift test

From the repo root, swift package --disable-sandbox dev runs the debug app with a stable signing identity so the Keychain's Always Allow answer survives rebuilds.

ThreadSanitizer

If you touch shared state, actors, locks, or anything nonisolated(unsafe), also run scripts/tsan.sh (serial, ~5–10 min).

Where to start

• The Architecture guide has the package layout, folder map and diagrams. On GitHub, read docs/architecture.md.
• CONTRIBUTING.md has the contributor conventions (Swift, error handling, logging, tests).
• The Issue tracker has a list of good first issues.