2023-11-30 04:31:18 +08:00
|
|
|
# Contributing to mlx-examples
|
|
|
|
|
|
|
|
|
|
We want to make contributing to this project as easy and transparent as
|
|
|
|
|
possible.
|
|
|
|
|
|
|
|
|
|
## Pull Requests
|
|
|
|
|
|
|
|
|
|
1. Fork and submit pull requests to the repo.
|
|
|
|
|
2. If you've added code that should be tested, add tests.
|
|
|
|
|
3. Every PR should have passing tests and at least one review.
|
2023-12-09 07:02:34 +08:00
|
|
|
4. For code formatting install `pre-commit` using something like `pip install pre-commit` and run `pre-commit install`.
|
2023-11-30 04:31:18 +08:00
|
|
|
This should install hooks for running `black` and `clang-format` to ensure
|
|
|
|
|
consistent style for C++ and python code.
|
|
|
|
|
|
|
|
|
|
You can also run the formatters manually as follows:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
clang-format -i file.cpp
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
black file.py
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
or run `pre-commit run --all-files` to check all files in the repo.
|
|
|
|
|
|
|
|
|
|
## Issues
|
|
|
|
|
|
|
|
|
|
We use GitHub issues to track public bugs. Please ensure your description is
|
|
|
|
|
clear and has sufficient instructions to be able to reproduce the issue.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
By contributing to mlx-examples, you agree that your contributions will be licensed
|
|
|
|
|
under the LICENSE file in the root directory of this source tree.
|
