Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (40 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

54 lines (40 loc) · 2.22 KB
Raw

Contributing to DisplayDawn

Thank you for helping improve DisplayDawn.

Before you start

  • Search existing issues before opening a new one.
  • Use a GitHub issue to discuss changes that affect device support, driver behavior, settings compatibility, or the user experience.
  • Keep changes focused. Avoid unrelated refactors in the same pull request.
  • Never commit certificates with private keys, signing credentials, access tokens, personal release approvals, device logs, or generated artifacts.
  • Report security issues privately as described in SECURITY.md.

Development environment

  • Windows 11 x64
  • .NET SDK version pinned in global.json
  • Apple Studio Display XDR for hardware integration testing

Restore, build, and run the test harness:

dotnet restore tests/XdrAutoBrightness.Tests/XdrAutoBrightness.Tests.csproj
dotnet build tests/XdrAutoBrightness.Tests/XdrAutoBrightness.Tests.csproj --configuration Release --no-restore
dotnet run --project tests/XdrAutoBrightness.Tests/XdrAutoBrightness.Tests.csproj --configuration Release --no-build

Tests that require real display hardware must be described explicitly in the pull request, including the Windows version, display connection, test steps, and observed result.

The normal build intentionally excludes the self-signed development sensor driver. Maintainers testing that package must opt in explicitly:

dotnet build src/XdrAutoBrightness.App/XdrAutoBrightness.App.csproj --configuration Release -p:EnableDevelopmentDriver=true

This imports a development certificate into local-machine trust stores during driver installation. Use only on a controlled test system and restore the original Windows driver afterward when appropriate.

Pull requests

  1. Create a branch from main.
  2. Add or update tests for behavior changes.
  3. Run the commands above and resolve all warnings.
  4. Update user-facing documentation when behavior or requirements change.
  5. Complete the pull request template, including driver and privacy impact.

By submitting a contribution, you agree that your contribution is licensed under the repository's MIT License. Third-party files must retain their original copyright and license notices.