Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (82 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

123 lines (82 loc) · 3.59 KB

Contributing to TablePro

Setup

Requirements: macOS 14.0+, Xcode 15+. Optional: SwiftLint, SwiftFormat, GitHub CLI (gh).

Fork the repo on GitHub, then:

git clone https://github.com/<your-fork>/TablePro.git && cd TablePro
scripts/download-libs.sh
touch Secrets.xcconfig
brew install swiftlint swiftformat

Building with a personal Apple team

To Debug-build under your own team, open TablePro.xcodeproj, select the TablePro target, then Signing & Capabilities → Debug sub-tab:

  1. Team: pick your personal team. If another target fails to sign later, repeat there.
  2. Bundle Identifier: change com.TablePro to something unique (e.g. com.<yourhandle>.TablePro).
  3. Code Signing Entitlements (Build Settings tab): switch Debug to TablePro/TablePro.Debug.entitlements. It ships in the repo and drops iCloud, which free teams don't support. Sync auto-disables at runtime.

Don't commit the resulting pbxproj changes. They break official Release signing. Skip them locally:

git update-index --skip-worktree TablePro.xcodeproj/project.pbxproj

To verify: save a connection password, relaunch, reopen. The password should still be there.

Build:

xcodebuild -project TablePro.xcodeproj -scheme TablePro -configuration Debug build -skipPackagePluginValidation

Tests:

xcodebuild -project TablePro.xcodeproj -scheme TablePro test -skipPackagePluginValidation

Code Style

.swiftlint.yml and .swiftformat are the source of truth. The short version:

  • 4-space indent, 120-char lines
  • Explicit access control (private, internal, public)
  • No force unwraps (!) or force casts (as!)
  • String(localized:) for user-facing strings
  • OSLog only, no print()

Before committing:

swiftlint lint --strict
swiftformat .

Commits

Conventional Commits, single line, no body.

feat: add CSV export for query results
fix: prevent crash on empty query result
docs: update keyboard shortcuts page

Branch Naming

Branch off main:

  • feat/add-cassandra-support
  • fix/query-editor-crash
  • docs/update-keyboard-shortcuts

Pull Requests

One logical change per PR. Make sure tests pass and lint is clean.

Checklist:

  • Tests added or updated
  • CHANGELOG.md updated under [Unreleased] (skip for unreleased-only fixes)
  • Docs updated in docs/ if the change affects user-facing behavior
  • User-facing strings localized
  • No SwiftLint/SwiftFormat violations

Project Layout

TablePro/              App source (Core/, Views/, Models/, ViewModels/, Extensions/, Theme/)
Plugins/               .tableplugin bundles + TableProPluginKit framework
Libs/                  Pre-built static libraries (downloaded via script, not in git)
TableProTests/         Tests
docs/                  Mintlify docs site
scripts/               Build and release scripts

Adding a Database Driver

Drivers are .tableplugin bundles loaded at runtime. Create a new bundle under Plugins/, implement DriverPlugin + PluginDatabaseDriver from TableProPluginKit, and add the target to the Xcode project.

Full guide: docs/development/plugin-registry

Reporting Bugs

Open a GitHub issue with:

  • macOS version
  • TablePro version
  • Reproduction steps
  • Database type and version (for database-specific bugs)

CLA

Sign the Contributor License Agreement on your first PR. The CLA bot walks you through it. One-time thing.

License

Contributions are licensed under AGPLv3.