47 lines (33 loc) · 703 Bytes

Contributing

Thanks for helping improve MacCarUnlock.

Development setup

Requirements:

macOS 10.12+
Xcode Command Line Tools

Build debug:

swift build

Run:

swift run

Build release DMG:

Scripts/package_app.sh
Scripts/build_dmg.sh

Commit messages

This repo uses tag-based releases and generates release notes from commit subjects.

Please prefer Conventional Commit prefixes:

feat: new feature
fix: bug fix
refactor: refactor
perf: performance
docs: docs only
test: tests
feat!: (or add BREAKING CHANGE) for breaking changes

Pull requests

Keep changes focused.
Update docs where relevant.
Prefer small PRs.