Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (30 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 1.11 KB

Contributing to Toast

Thank you for your interest in contributing!

Reporting Issues

Please open an issue and include:

  • iOS version and device / simulator
  • Xcode version
  • A minimal reproduction case
  • Expected vs. actual behavior

Submitting Changes

  1. Fork the repository and create a branch from main.
  2. Make your changes. Add or update tests as appropriate.
  3. Ensure all tests pass: swift test
  4. Open a pull request against main.

Code Style

  • Follow the existing code conventions (Swift API Design Guidelines).
  • Keep the public surface minimal — prefer internal implementation over new public API.
  • All new public API must have DocC documentation comments.
  • @MainActor isolation and Sendable conformance must be maintained throughout.

Tests

The test suite lives in ToastTests/ and uses Swift Testing (import Testing). Run tests with:

swift test

Tests must pass on the minimum deployment target (iOS 17).

License

By contributing, you agree that your contributions will be licensed under the MIT License.