Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (42 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

56 lines (42 loc) · 1.35 KB

Contributing to Amplify

Thanks for your interest in contributing!

Dev Setup

  1. Clone the repo:

    git clone https://github.com/YOUR_ORG/amplify.git
cd amplify/WritingHub

  2. Build and run:

    swift build
swift run

  3. Run tests:

    swift test

Requires Xcode 16+ and macOS 14+.

Code Style

  • Swift 6 strict concurrency
  • MVVM architecture (Views, ViewModels, Models, Services)
  • @MainActor for all UI-facing classes
  • Sendable conformance on all models
  • Prefer composition over inheritance

PR Process

  1. Fork the repo and create a feature branch from main
  2. Make your changes with clear, focused commits
  3. Ensure swift build && swift test passes
  4. Open a PR against main with a description of what and why
  5. One approval required to merge

Reporting Issues

Use GitHub Issues. Include:

  • macOS version
  • Steps to reproduce
  • Expected vs actual behavior
  • Console output if relevant

Architecture Notes

  • FolderManager handles file system operations (scaffold, save, load)
  • HubViewModel coordinates FolderManager, FileWatcher, and GitService
  • SkillPack defines folder structure + agent instructions template per persona
  • FileWatcher uses FSEvents with debouncing and self-write tracking
  • EditorView uses MarkupEditor for WYSIWYG editing with debounced auto-save