# Contributing

We encourage anyone who wants to contribute to the validation layer to submit
[Issues](https://github.com/oneapi-src/level-zero/issues) and
[Pull Requests](https://github.com/oneapi-src/level-zero/pulls). We will help
review these for proper alignment with the
[Level Zero Specification](https://spec.oneapi.com/level-zero/latest/index.html).

## C++ Coding Standards

* C++14 maximum support
* Avoid C Arrays, replace with `std::array<>` / `std::vector<>`
* Avoid "magic numbers"
* Avoid C-style memory allocations in favor of C++
* Use `nullptr` instead of `NULL`
* Don't add `void` to empty argument lists
* Use `std::unique_ptr` in place of `std::auto_ptr`

## Validation Checkers

* To allow for dynamic validation of input/outputs from all Level Zero APIs, the Validation Layer supports pluggable validation checkers.
* These pluggable validation checkers are compiled into the Validation layer and can be enabled thru per checker environment variables.
* Current Checkers are:
* * `PARAMETER_VALIDATION`
* To create your own checker, one must first generate the skeleton for the new checker using the `scripts/generate_checker.py`.
* Generate a checker template thru:
* * `python3 ./scripts/generate_checker.py <CheckerName> <Level Zero Loader Root Directory Path>.`
* * this will create a new folder at `source/layers/validation/checkers/<CheckerName>`
* * this folder will have 3 files, the `CMakeLists.txt` include file, `zel_<CheckerName>_checker.cpp`, and `zel_<CheckerName>_checker.h`
* * Naming Convention of the Checkers in the generator is `PascalCase`.
* * An `EXAMPLE` Checker is located [here](./checkers/template/zel_template_checker.cpp)
* Once one has generated the checker files, one can define intercepts for any of the functions in the Level Zero Specification.
* Each function allows for Prologue and Epilogue intercepts to check both the pre and post call parameters.
* In your generated class, one can overide any functions with:
* * `<L0API>Prologue(`
* * `<L0API>Epilogue(`
* Once your checker meets your needs, include your checker in the compile by adding your new checker folder to:
* * `source/layers/validation/checkers/CMakeLists.txt`
* Your new checker will need to be enabled during runtime with `ZEL_ENABLE_<CheckerName>_CHECKER=1` when the validation layer is enabled with `ZE_ENABLE_VALIDATION_LAYER=1`.

## Sign Your Work

Please use the sign-off line at the end of your patch. Your signature certifies
that you wrote the patch or otherwise have the right to pass it on as an
open-source patch. To do so, if you can certify the below
(from [developercertificate.org](http://developercertificate.org/)):

```
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

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.
```

Then add a line to every git commit message:

    Signed-off-by: Kris Smith <kris.smith@email.com>

Use your real name (sorry, no pseudonyms or anonymous contributions).

If you set your `user.name` and `user.email` git configs, you can sign your
commit automatically with `git commit -s`.