We want to make contributing to this project as easy and transparent as possible.
-
Fork and submit pull requests to the repo.
-
If you've added code that should be tested, add tests.
-
If a change is likely to impact efficiency, run some of the benchmarks before and after the change. Examples of benchmarks can be found in
benchmarks/python/
. -
If you've changed APIs, update the documentation.
-
Every PR should have passing tests and at least one review.
-
For code formatting install
pre-commit
using something likepip install pre-commit
and runpre-commit install
. This should install hooks for runningblack
andclang-format
to ensure consistent style for C/C++ and python code.You can also run the formatters manually as follows:
clang-format -i file.cpp clang-format -i file.c
black file.py
or run
pre-commit run --all-files
to check all files in the repo.
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.
By contributing to MLX-C, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.