How to Contribute Changes

Contribution Steps

• Build and debug the artifacts and / or user application
• File an [issue][https://github.com/ROCm-Developer-Tools/HIP-CPU/issues] and create a pull request with the change and we will review it.
• If the change impacts existent functionality, or adds new functionality, add a line describing the change to CHANGELOG.md.
• Please add a unit test in the corresponding .cpp file under /src; see The Pitchfork Layout convention for merged test placement.
• If the change adds functionality that is covered by an extant test that is part of the HIP GPU Runtime, please consider adding it in a new .cpp file under under /tests.
• Run tests:
  • Via CTest;
  • By executing the relevant build artifact:
    • legacy_tests for tests ported from the HIP GPU Runtime;
    • public_interface_tests for unit tests;
    • performance_tests for benchmarks.

About the Code

• The Pitchfork Layout is used to physically organise files; the separate header convention is adopted.
• The PPP Style Guide governs coding style; 80-character line-length is mandatory.
• The HIP CPU Runtime is fully implemented in C++, and a compliant C++ development environment is required
  • C++17 is the earliest supported language standard;
  • Full support is required both in the compiler and in the standard library; the HIP CPU Runtime will try to signal at compile time if features are missing.