As an open source project, we welcome community contributions to Intel(R) Extension for Scikit-learn. This document explains how to participate in project conversations, log bugs and enhancement requests, and submit code patches.
Intel(R) Extension for Scikit-learn uses the Apache 2.0 License. By contributing to the project, you agree to the license and copyright terms and release your own contributions under these terms.
No anonymous contributions are accepted. The name in the commit message Signed-off-by line and your email must match the change authorship information.
Make sure your .gitconfig is set up correctly so you can use git commit -s for signing your patches:
git config --global user.name "Kate Developer"
git config --global user.email kate.developer@company.com
- Make sure you can build the product and run all the tests with your patch.
- For a larger feature, provide a relevant test.
- Document your code. Our project uses reStructuredText for documentation.
- For new file(s), specify the appropriate copyright year in the first line.
- Submit a pull request into the main branch.
Continuous Integration (CI) testing is enabled for the repository. Your pull request must pass all checks before it can be merged. We will review your contribution and may provide feedback to guide you if any additional fixes or modifications are necessary. When reviewed and accepted, your pull request will be merged into our GitHub repository.
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 .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