Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (17 loc) · 818 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 818 Bytes
Raw

Contributing

Thanks for helping improve Aither.

Development

  1. Open Example/AitherPreview.xcodeproj in Xcode.
  2. Select the AitherPreview scheme and an iPhone Simulator.
  3. Make package changes in Sources/Aither.
  4. Build the package and preview app before opening a pull request.

Keep public API additions source-compatible whenever possible. New animation variants must remain seamless loops, stay visually contained inside the orb, and respect Reduce Motion.

Pull requests

  • Explain the user-facing reason for the change.
  • Include tests for behavioral API changes.
  • Include a short capture for visual or motion changes.
  • Avoid unrelated formatting or generated build artifacts.

By contributing, you agree that your contribution is licensed under the MIT License included in this repository.