Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.47 KB
Raw

Contribution Guide

Thanks for your interest in contributing. This project was released to accompany a research paper for purposes of reproducibility, and beyond its publication there are limited plans for future development of the repository.

While we welcome new pull requests and issues please note that our response may be limited. Forks and out-of-tree improvements are strongly encouraged.

Before you get started

By submitting a pull request, you represent that you have the right to license your contribution to Apple and the community, and agree by submitting the patch that your contributions are licensed under the LICENSE.

We ask that all community members read and observe our Code of Conduct.

Issues

If you have any question about our work, we encourage you to submit a new issue. If applicable, please try to include in your issue a minimal reproducible example, such as a code snippet or a command that was run.

Pull requests

We welcome new pull requests! If you wish to submit one, please follow these steps below:

  1. Fork the repository.
  2. Create a new branch from main and commit your changes.
  3. Ensure your code is linted.
    • This can be done by running pip install pre-commit and pre-commit install, which install the linter hooks
  4. Submit your PR.
  5. Wait until someone reviews the changes.