Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (25 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.27 KB
Raw

Contributing to Easy Write

Thanks for your interest! Easy Write is a small, focused native macOS app — contributions that keep it that way are very welcome.

Getting set up

./setup-signing.sh   # once — creates a stable self-signed identity so the Accessibility grant sticks
./build.sh           # compile + bundle + sign
open EasyWrite.app

Requires macOS 26+ on Apple Silicon with Apple Intelligence enabled. See HOW_IT_WORKS.md for an architecture tour before diving in.

Good first contributions

  • More target languages (add to Languages.swift)
  • Translation history
  • Preview-before-replace polish
  • Better long-text handling
  • Accessibility / VoiceOver improvements

Guidelines

  • Keep it private by default. No network calls, analytics, or telemetry. On-device only.
  • Keep it small. Prefer the standard library and system frameworks over dependencies.
  • Match the existing style; run a release build (swift build -c release) before opening a PR.
  • One focused change per PR, with a clear description of the user-facing effect.

Reporting bugs

Open an issue with your macOS version, whether Apple Intelligence is enabled, the app you were using, and steps to reproduce. Logs aren't collected (by design), so repro steps are gold.