How to Contribute - MLIR (original) (raw)
How to Contribute
Everyone is welcome to contribute to MLIR. There are several ways of getting involved and contributing including reporting bugs, improving documentation and tutorials.
Please be mindful of theLLVM Code of Conduct, which pledges to foster an open and welcoming environment.
Contributing code ¶
Please sendpull-request on GitHub. If you don’t have write access to the repo, just leave a comment asking the reviewer to hit the merge button it for you.
Commit messages ¶
Follow the git conventions for writing a commit message, in particular the first line is the short title of the commit. The title should be followed by an empty line and a longer description. Prefer describing why the change is implemented rather than what it does. The latter can be inferred from the code. Thispost give examples and more details.
Issue tracking ¶
To report a bug, use theMLIR product on the LLVM bug tracker, try to pick a suitable component for the bug, or leave it in the default.
If you want to contribute, start working through the MLIR codebase, navigate tothe “good first issue” issuesand 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 ¶
- Read thedeveloper guide.
- 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 tests, because the presence of bugs usually indicates insufficient test coverage.
License ¶
Include a license at the top of new files.