Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (31 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 1.57 KB
Raw

Contributing

Mference welcomes focused fixes, documentation improvements, and benchmark reports from Apple Silicon Macs.

Before opening a change

  • Keep the package compatible with macOS 15 and Swift 6.1. Metal 4 tensor-ops code must stay behind __HAVE_TENSOR__ in the shaders and behind the MetalSDKCompatibility.swift shims in Swift, with a working fallback path.
  • Preserve the bounded-memory model path. Never load a complete checkpoint, shard, or large model tensor into Swift heap memory.
  • Keep public runtime controls limited to those documented in Runtime controls.
  • Add or update a focused test for behavior changes.

Run the release build, serial tests, and Markdown link check:

swift build -c release
Scripts/test.sh
ruby Scripts/check_markdown_links.rb

These checks do not download or load the model. For a real-model change, also report the prompt, generated token count, output, timing footer, Mac model, memory, macOS version, Swift version, and any protocol change.

Benchmark reports

Follow the community benchmark protocol. Review all captured files before sharing them, and remove personal paths or unrelated process details.

Pull requests

Keep each pull request narrow. Explain the behavior change, tests run, and any remaining limitation. By contributing, you agree that your work is licensed under the repository's MIT License. Portions derived from TurboFieldfare remain under the Apache License 2.0; see THIRD_PARTY_NOTICES.md.