add admin files

This commit is contained in:
David Koski
2024-02-22 12:33:18 -08:00
parent a273fa1777
commit c917f5b524
5 changed files with 201 additions and 2 deletions

30
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,30 @@
# Contributing to MLX Swift 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 (if any) and at least one review.
4. For code formatting install `pre-commit` using something like `pip install pre-commit` and run `pre-commit install`.
If needed you may need to `brew install swift-format`.
You can also run the formatters manually as follows:
```
swift-format format --in-place --recursive Libraries Tools
```
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 Swift Examples, you agree that your contributions will be licensed
under the LICENSE file in the root directory of this source tree.