Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 5.22 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 5.22 KB
Raw

Contribution rules

  • DALI Coding Style Guide can be found here. We follow Google C++ Style Guide with few exceptions and additional guidelines regarding DALI-specific cases. See the DALI Coding Style Guide for details. When no rules can be found, follow the already occuring conventions. If there is no precedence in our codebase we are open to discussion.
  • Prior to your contribution, please make sure that the code passes the linter check. We do both C++ and Python linting. To invoke the check, please use the make lint command in your build directory. We use Flake8 as the Python linter, so you may need to install it.
  • Avoid introducing unnecessary complexity into existing code so that maintainability and readability are preserved.
  • Try to keep pull requests (PRs) as concise as possible:
    • Avoid committing commented-out code.
    • Wherever possible, each PR should address a single concern. If there are several otherwise-unrelated things that should be fixed to reach a desired endpoint, it is perfectly fine to open several PRs and state in the description which PR depends on another PR. The more complex the changes are in a single PR, the more time it will take to review those changes.
  • Write PR and commit titles using imperative mood.
    • Format commit messages sticking to rules described in this guide.
  • Make sure that the build log is clean, meaning no warnings or errors should be present.
  • Make sure all L0_* tests pass:
    • In the qa/ directory, there are basic sanity tests scripted in directories named L0_.... A given test can be executed by running the ./test.sh command in each test directory with no additional options needed.
      • Among other things, these tests will make use of dali_test.bin and dali_benchmark.bin, which require the BUILD_TEST and BUILD_BENCHMARK CMake options to be ON.
      • Some tests use licensed input datasets such as the ImageNet ILSVRC2012 set. If you don't have access to the necessary input datasets, you may skip those test(s), but please state in the PR comments which tests were not run.
  • To add or disable functionality:
    • Add a CMake option with a default value that matches the existing behavior.
    • Where entire files can be included/excluded based on the value of this option, selectively include/exclude the relevant files from compilation by modifying CMakeLists.txt rather than using #if guards around the entire body of each file.
    • Where the functionality involves minor changes to existing files, use #if guards.
  • DALI's default build assumes recent versions of DALI's dependencies (CUDA, OpenCV, libjpeg-turbo, etc.). Contributions that add compatibility with older versions of those dependencies will be considered, but NVIDIA cannot guarantee that all possible build configurations work, are not broken by future contributions, and retain highest performance.
  • Make sure that you can contribute your work to open source (no license and/or patent conflict is introduced by your code). You need to sign your commit.
  • Thanks in advance for your patience as we review your contributions; we do appreciate them!

Sign your Work

We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.

Any contribution which contains commits that are not Signed-Off will not be accepted.

To sign off on a commit you simply use the --signoff (or -s) option when committing your changes:

$ git commit -s -m "Add cool feature."

This will append the following to your commit message:

Signed-off-by: Your Name <your@email.com>

By doing this you certify the below:

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.