Contributing

How to build, test, and contribute to Commit+.

Commit+ is open source under the AGPLv3. Contributions are welcome.

Start here

Use Local Development to set up the app, run the test suite, and preview the docs site.

Build the app

xcodebuild -project macgit.xcodeproj -scheme macgit -destination 'platform=macOS' build

Test the app

xcodebuild -project macgit.xcodeproj -scheme macgit -destination 'platform=macOS' test

Tests live in macgitTests/ and use XCTest, creating real temporary Git repositories for integration tests.

Style

• Follow existing Swift / SwiftUI conventions in the codebase.
• Keep changes focused and small enough to review.
• Keep docs aligned with shipped behavior. Use roadmap or planned language for future work.
• Preserve the lightweight Git core. Do not add runtime dependencies for Git workflows without a strong reason.
• Treat Sparkle as update infrastructure only, not as part of the repository workflow engine.
• Do not launch the app as a substitute for verification. Use xcodebuild build and test output as the baseline evidence.

Docs changes

For docs-only changes in docs-page/:

npm run lint
npm run broken-links