Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.55 KB
Raw

We appreciate any contribution to the Intel® Geti™ SDK, whether it's in the form of a Pull Request, Feature Request or general comment/issue that you found. For feature requests and issues, please feel free to create a GitHub Issue in this repository.

Development and pull requests

To set up your development environment, please follow the steps below:

  1. Fork the repo.

  2. Install the requirements for running the test suite using pip install -r requirements/requirements-dev.txt.

  3. Create your branch based off the main branch.

  4. Make sure that git lfs is configured for your Git account, by following the steps here. Git LFS (Large File Storage) is used in this repo to manage certain data files used in the tests.

  5. Run git lfs pull to download the test data.

  6. Verify that the integration tests now run locally by executing pytest tests/integration

  7. Set up the pre-commit hooks in the repo by running pre-commit install. Several pre-commit hooks are used in the repo, to perform static code scans like linting (flake8), import sorting (isort) and code formatting (black). The pre-commit install command sets up all of these hooks so that the checks will be performed on each commit you make.

You should now be ready to make changes, run the SDK integration tests and create a Pull Request!

Testing your code

More details about the tests can be found in the readme for the test suite. If your changes require updating the tests or the test data, please refer to that document.