Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 1.64 KB

Contributing to MLX Code

Thank you for your interest in contributing! We welcome contributions from the community.

How to Contribute

Reporting Bugs

  • Use the GitHub Issues tab
  • Use the bug report template
  • Include steps to reproduce, expected behavior, and screenshots if applicable

Suggesting Features

  • Open a feature request issue
  • Describe the use case and expected behavior
  • Explain why this would benefit other users

Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Ensure code compiles without warnings
  5. Test thoroughly on macOS with Apple Silicon
  6. Commit with clear messages (git commit -m 'feat: Add amazing feature')
  7. Push to your branch (git push origin feature/amazing-feature)
  8. Open a Pull Request

Development Setup

Requirements

  • macOS 14.0 (Sonoma) or later
  • Xcode 15.0+
  • Swift 5.9+
  • Apple Silicon (M1/M2/M3/M4)
  • Python 3.9+ with mlx-lm installed

Building

git clone https://github.com/kochj23/MLXCode.git
cd MLXCode
open "MLX Code.xcodeproj"

Code Standards

  • Follow Swift API Design Guidelines
  • No compiler warnings allowed
  • Write clear commit messages using conventional commits
  • Add tests for new features
  • Document public APIs

Security

  • Never commit credentials, API keys, or secrets
  • Store all secrets in macOS Keychain
  • Report security vulnerabilities privately (see SECURITY.md)
  • Follow OWASP security best practices

License

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