Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

77 lines (58 loc) · 3.67 KB
Raw

Intel® Data Mover Library (Intel® DML) Contribution Rules

How to Contribute

We welcome community contributions to Intel DML!

If you have an idea how to improve the product:

Intel DML Repository Scheme

Intel DML supports two repositories named as "Public Repository" and "Mirror". Privately hosted "Mirror" is required for extensive internal testing and experimental features development.

Existing automation guarantees the same commits history for both repositories.

  +-------------+                     +------------+
  | Public Repo |                     |   Mirror   |
  | ----------- |   synchronization   |   -------  |       +----------+
  |    rev.1    | <-----------------> |    rev.1   |       | internal |
  |    rev.2    |   of each commit    |    rev.2   |-----> | testing  |
  |    rev.3    |                     |    rev.3   |       +----------+
  +-------------+                     +------------+

Contribution Flow

  • Contributor creates fork from develop, commits the changes into the created branch, opens a PR, and requests a review.
  • Intel DML repository maintainer must ensure that the code is safe for internal execution, get code into "Mirror", and run private testing.
  • Contributor applies feedback provided by Intel DML repository maintainer in opened PR.
  • Intel DML repository maintainer merges the changes "as is" from "Mirror", when private testing is passed.

Note Original PR is closed because merging PRs on the external GitHub repo isn't supported.

  • Merging into "Mirror" triggers synchronization and makes contributions available in the "Public" repository.
  +-----------------+
  |   Public Repo   |
  |   -----------   |                     +---------------------+
  |   PR is open    |                     |       Mirror        |
  |       |         | PR is cherry-picked |       ------        |
  |       |---------|---------------------|--> Heavy private    |
  |       |         |     to "Mirror"     |       testing       |
  |  Code Review    |                     |          |          |
  |   has passed    |                     |          |          |
  |       |         |  synchronization    |          |          |
  |       |---------|---------------------|-> Cherry-picked PR  |
  |       |         |      point          |       is merged     |
  |  PR is closed   |                     |      to "Mirror"    |
  +-----------------+                     +---------------------+

Pull Request Checklist

Before sending your pull requests, ensure that:

  • Intel DML builds successfully with proposed changes.
  • Changes don't bring new failed functional tests. List of failed tests are listed in latest Release Notes. Read more about functional tests in Testing.
  • For new APIs "algorithmic", "bad arguments" tests are implemented and passed. Read more about type of functional tests in Functional tests.

Documentation Guidelines

Intel DML uses Doxygen for inline comments in public header files that are used to build the API reference. Use documentation instructions to generate full documentation from sources with Doxygen.