Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

68 lines (53 loc) · 2.8 KB

Contributing to Tensor Comprehensions

We want to make contributing to this project as easy and transparent as possible.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.

Complete your CLA here: https://code.facebook.com/cla

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.

Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.

Coding Style

  • 2 spaces for indentation rather than tabs for C/C++ files
  • 80 character line length
  • Please read CodingConvenstions.md file for more conventions

License

By contributing to TC, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.

Automatic formatting

Format your contributed changes with clang-format (using the provided .clang-format configuration: clang-format -style=file -i file_to_format).

This can be done automatically by installing the following pre-commit hook

#!/bin/sh
git diff-index --cached --name-only HEAD | grep -v .md | grep -v third-party | grep -v .txt | grep -v .sh | xargs ./third-party-install/clang+llvm/bin/clang-format -i -style=file
git diff-index --cached --name-only HEAD | xargs git add

Paste this code into ./.git/hooks/pre-commit and run chmod +x ./.git/hooks/pre-commit. Note: this will reformat add re-stage all files that you are about to commit. Even if you cancel the commit (i.e. by supplying an empty commit message), the staged files will remain formatted. More info on git hooks.

Alternatively, you can use clang's git-clang-format.py to format all files that were touched before committing.

Another alternative is to use the provided script:

CLANG=${PATH_TO_CLANG_INSTALL_BINARY}/clang-format ./check_and_fix_format.sh

Changes to isl submodule

If you update the isl submodule, then you will typically also need to update the C++ bindings in isl_interface. To generate these bindings, you need to build with WITH_BINDINGS=ON.