# Contributing to Kineto

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

## Code of Conduct

The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md).

## Pull Requests

We actively welcome your pull requests.

1. Fork the repo and create your branch from `main`.
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").

## Code Formatting and Linting

Kineto uses `lintrunner` for code formatting and linting, the same tool used by
PyTorch.

### Installing lintrunner

```bash
pip install lintrunner
```

### Running lintrunner

First, initialize lintrunner (this downloads/verifies linter dependencies):

```bash
lintrunner init
```

To check your code:

```bash
lintrunner
```

To automatically fix issues:

```bash
lintrunner -a
```

To lint specific files:

```bash
lintrunner path/to/file.cpp
```

### What lintrunner checks

- **CLANGFORMAT**: C++ code formatting (automatically fixes spacing,
  indentation, style)
- **NEWLINE**: Ensures files end with exactly one newline
- **SPACES**: Detects and removes trailing whitespace
- **TABS**: Ensures spaces are used instead of tabs

### Continuous Integration

GitHub Actions will automatically run lintrunner on all pull requests. Make sure
to run `lintrunner -a` locally before pushing to avoid CI failures.

## 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](https://www.facebook.com/whitehat/) 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.

## License

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