Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

70 lines (49 loc) · 3.36 KB
Raw

How to Contribute

We welcome community contributions to Intel(R) oneAPI Data Analytics Library. 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.
  • Make sure your code is in line with our coding style as clang-format is one of the checks in our public CI.
  • For a larger feature, provide a relevant example.
  • Document your code.
  • Submit a pull request into the main branch.

Public and private CIs are 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

ClangFormat

Prerequisites: ClangFormat 9.0.0 or later

Our repository contains clang-format configurations that you should use on your code. To do this, run:

clang-format style=file <your file>

Refer to ClangFormat documentation for more information.

Coding Guidelines

For your convenience we also added coding guidelines with examples and detailed descriptions of the coding style oneDAL follows. We encourage you to consult them when writing your code.

Documentation Guidelines

oneDAL uses Doxygen for inline comments in public header files that are used to build the API reference and reStructuredText for the Developer Guide. See oneDAL documentation for reference.

Note: oneDAL is licensed under Apache License, Version 2.0. By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.