Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

55 lines (41 loc) · 2.73 KB
Raw

How to Contribute

We welcome community contributions to Intel(R) Extension for Scikit-learn. You can:

  • Submit your changes directly with a pull request.
  • Log a bug or make a feature request with an issue.

Refer to our guidelines on pull requests and issues before you proceed.

Issues

Use GitHub issues to:

  • report an issue
  • make a feature request

Note: To report a vulnerability, refer to Intel vulnerability reporting policy.

Pull Requests

To contribute your changes directly to the repository, do the following:

  • Make sure you can build the product and run all the examples with your patch.
  • For a larger feature, provide a relevant example.
  • Document your code.
  • Submit a pull request into the master branch. Provide a brief description of the changes you are contributing.

Public CI is enabled for the repository. Your PR should pass all of our checks. We will review your contribution and, if any additional fixes or modifications are necessary, we may give some feedback to guide you. When accepted, your pull request will be merged into our GitHub repository.

Code Style

We use black and isort formatters for Python* code. The line length is 90 characters; use default options otherwise. You can find the linter configuration in our .pyproject.toml. A GitHub* Action verifies if your changes comply with the output of the auto-formatting tools.

Optionally, you can install pre-commit hooks that do the formatting for you. For this, run from the top level of the repository:

pip install pre-commit
pre-commit install