3.1 KiB
How to Contribute
Everyone is welcome to contribute to MLIR. There are several ways of getting involved and contributing including reporting bugs, improving documentation, writing models or tutorials.
Please read our Code of Conduct before participating.
Community Guidelines
This project follows Google's Open Source Community Guidelines.
How to become a contributor and submit your own code
Contributor License Agreements
We'd love to accept your patches! Before we can take them, please fill out either the individual or corporate Contributor License Agreement (CLA).
- If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.
- If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.
Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
NOTE: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.
Contributing code
If you have improvements to MLIR, send us your pull requests! For those just getting started, GitHub has a howto.
MLIR team members will be assigned to review your pull requests. Once the pull requests are approved and pass continuous integration checks, a team member will merge your pull request submitted to our internal repository. After the change has been submitted internally, your pull request will be merged automatically on GitHub.
If you want to contribute, start working through the MLIR codebase, navigate to Github "issues" tab and start looking through interesting issues. If you decide to start on an issue, leave a comment so that other people know that you're working on it. If you want to help out, but not alone, use the issue comment thread to coordinate.
Contribution guidelines and standards
- Follow coding style (see below).
- Ensure that you use the correct license. Examples are provided below.
- Include tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost.
- Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage.
License
Include a license at the top of new files.
C++ coding style
Changes to MLIR C++ code should conform to LLVM Coding standards.