Contributing to Docky

Thanks for your interest in improving Docky. Contributions of all kinds are welcome: bug reports, fixes, features, and documentation.

Community

Join the Docky Discord to ask questions, share widgets, and follow development. Sponsors get a supporter role there.

Reporting issues

Open an issue at https://github.com/josejuanqm/docky/issues. Helpful reports include:

macOS version and Mac model
Docky version (Settings shows the build)
Steps to reproduce
A diagnostic bundle: Settings -> Feedback builds one and reveals it in Finder, so you can attach it to the issue.

Development setup

Fork and clone the repository.
Open Docky.xcodeproj in Xcode 16 or later.
Build and run the Docky scheme.

The project uses Xcode's file-system-synchronized groups, so new source files under Docky/ are picked up automatically without editing the project file.

Pull requests

Branch off main and keep changes focused.
Match the surrounding code style; Docky leans on AppKit + SwiftUI and uses explanatory comments only where the reasoning is non-obvious (for example, the private-API usage in Docky/Private/).

Verify the app builds and runs before opening a PR:

xcodebuild -project Docky.xcodeproj -scheme Docky \
  -configuration Debug -destination 'platform=macOS' \
  CODE_SIGNING_ALLOWED=NO build

Describe what changed and why, and include before/after notes or screenshots for UI changes.

Private APIs

Docky relies on private SkyLight / CoreGraphics Services and Accessibility SPI. When touching Docky/Private/, document why a given call is needed and what breaks without it, so the next reader understands the tradeoff.

License

By contributing, you agree that your contributions are licensed under the GNU General Public License v3.0, the same license that covers the project.

1.9 KiB Raw Blame History