Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 4.54 KB

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 4.54 KB
Raw

How to Contribute

As an open source project, we welcome community contributions to oneAPI Threading Building Blocks (oneTBB). This document explains how to participate in project conversations, log bugs and enhancement requests, and submit code patches to the project.

Licensing

Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired. The oneTBB project uses the Apache 2.0 License, a permissive open source license that allows you to freely use, modify, and distribute your own products that include Apache 2.0 licensed software. By contributing to the oneTBB project, you agree to the license and copyright terms therein and release your own contributions under these terms.

Some imported or reused components within oneTBB use other licenses, as described in third-party-programs.txt. By carefully reviewing potential contributions and enforcing a Developer Certification of Origin (DCO) for contributed code, we can ensure that the community can develop products with oneTBB without concerns over patent or copyright issues.

The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, (described later), the developer simply adds a Signed-off-by statement and thereby agrees to the DCO.

Prerequisites

As a contributor, you’ll want to be familiar with the oneTBB project and the repository layout. You should also know how to use it as explained in the oneTBB documentation and how to set up your build development environment to configure, build, and test oneTBB as explained in the oneTBB Build System Description.

Issues

If you face a problem, first check out open oneTBB GitHub issues to see if the issue you’d like to address is already reported. You may find users that have encountered the bug you’re finding or have similar ideas for changes or additions.

You can use issues to report a problem, make a feature request, or add comments on an existing issue.

Pull Requests

You can find all open oneTBB pull requests on GitHub.

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 "Taylor Developer"

git config --global user.email taylor.developer@company.com

Before contributing changes directly to the oneTBB repository

  • 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. The oneTBB project uses reStructuredText for documentation.
  • Update the copyright year in the first line of the changing file(s). For example, if you commit your changes in 2022:
    • the copyright year should be 2005-2022 for existing files
    • the copyright year should be 2022 for new files
  • Submit a pull request into the master branch. You can submit changes with a pull request (preferred) or by sending an email patch.

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.