Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (40 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 1.2 KB
Raw

Contributing to DisplayFill

Development Setup

  • macOS 15.2 or later
  • Xcode 16.2 or later

Clone the repository and open the project:

git clone https://github.com/dashhuang/DisplayFill.git
cd DisplayFill
open DisplayFill.xcodeproj

Local Checks

Before opening a pull request, run at least the Release build check:

xcodebuild -project DisplayFill.xcodeproj -scheme DisplayFill -configuration Release -destination 'generic/platform=macOS' CODE_SIGNING_ALLOWED=NO build

If you want a faster source-level check:

xcrun swiftc -typecheck DisplayFill/*.swift

Reporting Bugs

Please include:

  • macOS version
  • Mac model and chip
  • Display setup
  • Whether HDR was enabled
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots or crash logs when relevant

For display-related bugs, mention whether you were using:

  • A built-in display
  • Apple Studio Display
  • Pro Display XDR
  • Another external HDR monitor

Pull Requests

Keep pull requests focused and easy to review.

  • Explain the user-visible change
  • Note any behavior changes around HDR, multi-display handling, or menu bar UI
  • Include verification steps
  • Mention unresolved risks or follow-up work