1- # Contributing to MLXCode
1+ # Contributing to MLX Code
22
33Thank you for your interest in contributing! We welcome contributions from the community.
44
@@ -19,23 +19,25 @@ Thank you for your interest in contributing! We welcome contributions from the c
19192 . Create a feature branch (` git checkout -b feature/amazing-feature ` )
20203 . Make your changes
21214 . Ensure code compiles without warnings
22- 5 . Test thoroughly on macOS
22+ 5 . Test thoroughly on macOS with Apple Silicon
23236 . Commit with clear messages (` git commit -m 'feat: Add amazing feature' ` )
24247 . Push to your branch (` git push origin feature/amazing-feature ` )
25258 . Open a Pull Request
2626
2727## Development Setup
2828
2929### Requirements
30- - macOS 13 .0 (Ventura ) or later
30+ - macOS 14 .0 (Sonoma ) or later
3131- Xcode 15.0+
3232- Swift 5.9+
33+ - Apple Silicon (M1/M2/M3/M4)
34+ - Python 3.9+ with ` mlx-lm ` installed
3335
3436### Building
3537``` bash
3638git clone https://github.com/kochj23/MLXCode.git
3739cd MLXCode
38- open * .xcodeproj
40+ open " MLX Code .xcodeproj"
3941```
4042
4143## Code Standards
@@ -49,13 +51,10 @@ open *.xcodeproj
4951## Security
5052
5153- ** Never commit credentials, API keys, or secrets**
54+ - Store all secrets in macOS Keychain
5255- Report security vulnerabilities privately (see [ SECURITY.md] ( SECURITY.md ) )
5356- Follow OWASP security best practices
5457
55- ## Code of Conduct
56-
57- This project follows the [ Contributor Covenant Code of Conduct] ( CODE_OF_CONDUCT.md ) . By participating, you agree to uphold this code.
58-
5958## License
6059
6160By contributing, you agree that your contributions will be licensed under the MIT License.
0 commit comments