Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 2.2 KB
Raw

Apple MLX Tutorials Contribution Guidelines

Thank you for considering contributing to the Apple MLX Tutorials project owned by Isuru Alagiyawanna. By participating in this project, you agree to abide by the following guidelines.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

We welcome contributions from the community! To contribute to the Apple MLX Tutorials, follow these steps:

  1. Fork the Repository:

    • Fork the repository to your GitHub account.

  2. Clone Your Fork:

    • Clone the forked repository to your local machine. 
      git clone https://github.com/your-username/apple-mlx-tutorials.git

  3. Create a Branch:

    • Create a new branch for your contribution. 
      git checkout -b feature-branch

  4. Make Changes:

    • Make your changes, ensuring they adhere to the coding standards.

  5. Commit Changes:

    • Commit your changes with a clear and descriptive commit message. 
      git add .
git commit -m "Your descriptive commit message"

  6. Push Changes:

    • Push your changes to your fork on GitHub. 
      git push origin feature-branch

  7. Create a Pull Request:

    • Open a pull request on the original repository.
    • Provide a detailed description of your changes.

  8. Code Review:

    • Expect feedback and be responsive to it.
    • Make any necessary changes as suggested.

  9. Merge:

    • After approval, your pull request will be merged into the main project.

Reporting Issues

If you encounter any issues or have suggestions, please open an issue on the issue tracker.

Style Guide

Please follow our style guide when contributing code.

Licensing

By contributing to the Apple MLX Tutorials, you agree that your contributions will be licensed under the LICENSE file.

Contact

If you have any questions or need further clarification, feel free to reach out to the project owner, Isuru Alagiyawanna, at [[email protected]].