Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (32 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 1.03 KB

Contributing

Thank you for your interest in contributing to this project!

Prerequisites

  • Xcode 16.0 or later
  • macOS

Commits

Make sure to use conventional commits

Development Setup

  1. Clone this repository.
  2. Open the package in Xcode.
  3. Start coding!

Testing

  1. Please ensure all tests pass before submitting changes.
  2. If possible, add tests to your PR.

Enhancing Existing Functions

  • You are welcome to improve existing functions.
  • Avoid introducing breaking changes.

Adding New Functions

  • Open an issue to discuss your idea before starting work.
  • Do not add third-party dependencies to the core package to keep it lightweight.

Creating Add-ons

  • New add-ons and extensions are welcome!

Project Structure

Sources/
  core/        - Core package
  extension/   - Extensions for classes and structs

Code Style

Use Xcode’s built-in formatting tools. then you're good to go!

Thank You

We appreciate your contributions. You are awesome!