Repository navigation
Update CONTRIBUTING.md #4469
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update CONTRIBUTING.md #4469
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,97 @@ | ||
| # Contributing to MLX | ||
| # Welcome to the MLX community! | ||
|
|
||
| We want to make contributing to this project as easy and transparent as | ||
| possible. | ||
| We welcome contributors of all backgrounds and experience levels. A community with diverse perspectives builds software with lasting impact. | ||
|
|
||
| ## AI Usage Policy | ||
| [🤝 How you can help](#how-you-can-help) · [⚙️ Setting up your environment](#setting-up-your-environment) · [📝 Submitting issues and pull requests](#submitting-issues-and-pull-requests) · [🔀 Pull requests](#pull-requests) · [❤️ Code of conduct](#code-of-conduct) | ||
|
|
||
| AI-generated code is allowed. What is not allowed is submitting code you do not | ||
| understand. You are 100% responsible for every line, however it was produced, | ||
| and must explicitly disclose the manner in which AI was employed. | ||
| ## How you can help | ||
|
|
||
| It is strictly prohibited to use AI to write your posts for you (bug reports, | ||
| feature requests, pull request descriptions, Github discussions, responding to | ||
| humans, ...). | ||
| - Report bugs with clear, reproducible steps | ||
| - Improve documentation to make the project more accessible | ||
| - Triage issues by providing feedback, testing, and validation | ||
| - Propose and implement enhancements of all sizes | ||
| - Share your experience by speaking about MLX at conferences or meetups | ||
|
|
||
| ## Pull Requests | ||
| ## Setting up your environment | ||
|
|
||
| - Make sure new code is covered by tests. Add new tests if not, and confirm | ||
| the new tests fail in the main branch. | ||
| - If performance may be impacted, run benchmarks for both the main branch and | ||
| the pull request. | ||
| See [Build and Install](https://ml-explore.github.io/mlx/build/html/install.html) for setup instructions. | ||
|
|
||
| ## Submitting issues and pull requests | ||
|
|
||
| We maintain high standards to ensure quality across the project. | ||
|
|
||
| Your contributions are evaluated on: | ||
|
|
||
| - Technical quality and correctness | ||
| - Adherence to existing conventions and architectural patterns | ||
| - Demonstrated understanding of the implementation and its implications | ||
| - Clarity of communication | ||
| - Maintainability | ||
|
|
||
| You may use productivity tools, including AI-assisted coding, to help you work more efficiently. | ||
| However, you remain fully accountable for all submitted code, issues, pull requests, and comments. | ||
| AI-generated content must meet the same standards as human-written contributions. Review, validate, and, as needed, | ||
| refine or rearrange AI-assisted work so the final contribution reflects your human creativity, understanding, and | ||
| control. Use your voice and expression when producing written materials. Misuse of AI tools in your contributions | ||
| and conversations may be considered a violation of our [Code of Conduct](#code-of-conduct). | ||
|
|
||
| ### Issues | ||
|
|
||
| Before submitting an issue: | ||
|
|
||
| - Search [existing issues](../../issues) to avoid duplicates. | ||
| - Write a clear, concise title and a detailed description. Ensure all information is accurate and fully understood by you. | ||
| - Include precise steps to reproduce the issue, expected behavior, and actual behavior. Verify these steps yourself. | ||
| - Specify your environment, MLX version, and any relevant configurations. | ||
| - Explain the severity and impact of the problem. | ||
| - For security issues, please see the [MLX security advisories](https://github.com/ml-explore/mlx?tab=security-ov-file). Do **not** open a public GitHub issue. | ||
|
|
||
| #### Proposing features | ||
|
|
||
| We welcome feature requests. Describe the proposed changes needed and why they matter. Please do not start with a pull request. Use the issue template that best matches your needs. | ||
|
|
||
| ### Pull requests | ||
|
|
||
| ⚠️ **Important:** We recommend an issue for larger changes to the codebase. | ||
|
|
||
| Pull requests represent proposed solutions or enhancements. When submitting a pull request, verify it meets these expectations: | ||
|
|
||
| - They should match an open issue but may not always. | ||
| - Address the stated problem or feature request completely and effectively. You must fully understand and validate your proposed solution. | ||
| - Solutions must be thorough, handle edge cases, and integrate cleanly. | ||
| - Include comprehensive tests that validate your changes and prevent regressions. | ||
| - If performance may be impacted, run benchmarks for both the main branch and the pull request. | ||
| - When providing benchmarking results, include scripts and reproduction steps. | ||
| - Format the code with `uvx pre-commit run --all` before submitting a pull | ||
| request. You can also install git hooks to run it automatically: | ||
|
|
||
| #### Pull request style guide and format | ||
|
|
||
| Follow our coding style and formatting to maintain a consistent, readable codebase. | ||
|
|
||
| - Write comprehensive and clear documentation. Concisely explain the 'why' behind complex decisions. | ||
| - Write clear, concise, and descriptive commit messages. | ||
| - Format the code with `pre-commit run --all` before submitting a pull request. You can also install git hooks to run it automatically: | ||
|
|
||
| ```shell | ||
| pip install pre-commit | ||
| pre-commit install | ||
| ``` | ||
|
|
||
| ## Issues | ||
| #### Testing | ||
|
|
||
| All contributions require thorough testing. | ||
|
|
||
| **Local Testing:** Ensure all existing tests pass before submitting: | ||
|
|
||
| ```bash | ||
| python3 python/tests/run.py | ||
| ``` | ||
|
|
||
| **Automated Tests:** New features and bug fixes require corresponding automated tests that validate the intended behavior and prevent regressions. | ||
|
|
||
| #### Running CI | ||
|
|
||
| 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. | ||
| CI runs automatically on every pull request and needs to be approved by a maintainer before it will run. | ||
|
|
||
| ## License | ||
| ## Code of conduct | ||
|
|
||
| By contributing to MLX, you agree that your contributions will be licensed | ||
| under the LICENSE file in the root directory of this source tree. | ||
| We are committed to fostering a community where different experiences and perspectives come together to create and collaborate. Good collaboration depends on honest feedback and respect for the time and effort every contributor brings to this project. [Please review our Code of Conduct](https://github.com/ml-explore/.github/blob/main/CODE_OF_CONDUCT.md); all community members are expected to adhere to it. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a way how we can include this requirement?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have to use languages approved by Apple lawyers unfortunately, the rule is still there just not standing out: