Media/compute-runtime
1
0
Fork 0
mirror of https://github.com/intel/compute-runtime.git synced 2025-09-20 13:11:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Additional documentation

Browse Source 
Change-Id: I14edea5e1fc745344151bcc63a95279286bce886
This commit is contained in:
Rozenfeld, Piotr
2018-02-27 21:58:29 +01:00
committed by sys_ocldev
parent d510f8c865
commit 7b30a7c2b8
4 changed files with 136 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
documentation/CONTRIB.md Normal file
View File

@ -0,0 +1,48 @@
# Contribution guidelines
## Process overview
### 1. Patch creation
Start with a patch (we prefer smaller self-contained incremental changes vs. large blobs of code).
When adding new code, please also add corresponding unit level tests (ULT). Added ULTs should cover
all the decision points introduced by the commit and should fail if executed without the code changes.
Make sure it builds and passes _all_ ULT tests. For details about what compilers and build configurations
we expect, refer to [BUILD.md](https://github.com/intel/compute-runtime/blob/master/documentation/BUILD.md).
Make sure you adhere to our coding standard - this will be verified by clang-format and clang-tidy
(tool configuration is already included in NEO repository).
### 2. Patch submission
Create a pull request on github once you are confident that your changes are complete and fulfill
the requirements above. Make sure your commit message contains meaningful title (first line).
A few sentences of additional description is also required. All lines in the commit messages have 80 characters limit.
### 3. Initial (cursory) review
One of NEO maintainers will do an initial (brief) review of your code. We will let you know if anything major is missing.
### 4. Verification
We'll double-check that your code meets all of our minimal quality expectations (for every commit - see [RELEASES.md](https://github.com/intel/compute-runtime/blob/master/documentation/RELEASES.md)).
When all the automated checks are confirmed to be passing, we will start actual code review process.
### 5. Code review
We'll make sure that your code fits within the architecture and design of NEO, is readable and maintainable. Please make sure to address our questions and concerns.
### 6. Patch disposition
We reserve, upon conclusion of the code review, the right to do one of the following:
1. Merge the patch as submitted
2. Merge the patch (with modifications)
3. Reject the patch
If merged, you will be listed as patch author.
Your patch may be reverted later in case of major regression that was not detected prior to commit.
## Intel Employees
If you are an Intel Employee *and* you want to contribute to NEO as part of your regular job duties, please:
* Contact us in advance
* Make sure your github account is linked to your intel.com email address