|
| 1 | +# Contributing |
| 2 | + |
| 3 | +## Issues |
| 4 | + |
| 5 | +GitHub Issues tracks sample development issues, bugs, and feature requests. |
| 6 | +For usage, installation, or other requests for help, please use the [Intel® oneAPI Forums](https://software.intel.com/en-us/forums/intel-oneapi-forums) instead. |
| 7 | + |
| 8 | +When reporting a bug, please provide the following information, where applicable: |
| 9 | + |
| 10 | +* What are the steps to reproduce the bug? |
| 11 | +* Can you reproduce the bug using the latest [master](https://github.com/samples-ci/oneAPI-samples) and the latest oneAPI toolkit related to the sample? |
| 12 | +* What CPU/GPU, platform, operating system/distribution are you running? The more specific, the better. |
| 13 | + |
| 14 | + |
| 15 | +### Contribution Guide |
| 16 | + |
| 17 | +We accept contributions as pull requests on GitHub. Please follow these simple rules and [Git Steps for contribution](https://github.com/oneapi-src/oneAPI-samples/wiki/Git-Steps-for-Contribution) |
| 18 | + |
| 19 | +* A PR should have a clear purpose, and do one thing only, and nothing more. This will enable us review your PR more quickly. |
| 20 | +* Each commit in PR should be a small, atomic change representing one step in development. |
| 21 | +* Please squash intermediate steps within PR for bugfixes, style cleanups, reversions, etc., so they would not appear in merged PR history. |
| 22 | +* Please explain anything non-obvious from the code in comments, commit messages, or the PR description, as appropriate. |
| 23 | +* Please follow [Git Steps for contribution](https://github.com/oneapi-src/oneAPI-samples/wiki/Git-Steps-for-Contribution). |
| 24 | + |
| 25 | +### License |
| 26 | + |
| 27 | +The code samples are licensed under the terms in [LICENSE](https://github.com/oneapi-src/oneAPI-samples/blob/master/License.txt). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms. |
| 28 | + |
| 29 | +### Sign your work |
| 30 | + |
| 31 | +Please use the sign-off line at the end of the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify |
| 32 | +the below (from [developercertificate.org](http://developercertificate.org/)): |
| 33 | + |
| 34 | +``` |
| 35 | +Developer Certificate of Origin |
| 36 | +Version 1.1 |
| 37 | +
|
| 38 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 39 | +660 York Street, Suite 102, |
| 40 | +San Francisco, CA 94110 USA |
| 41 | +
|
| 42 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 43 | +license document, but changing it is not allowed. |
| 44 | +
|
| 45 | +Developer's Certificate of Origin 1.1 |
| 46 | +
|
| 47 | +By making a contribution to this project, I certify that: |
| 48 | +
|
| 49 | +(a) The contribution was created in whole or in part by me and I |
| 50 | + have the right to submit it under the open source license |
| 51 | + indicated in the file; or |
| 52 | +
|
| 53 | +(b) The contribution is based upon previous work that, to the best |
| 54 | + of my knowledge, is covered under an appropriate open source |
| 55 | + license and I have the right under that license to submit that |
| 56 | + work with modifications, whether created in whole or in part |
| 57 | + by me, under the same open source license (unless I am |
| 58 | + permitted to submit under a different license), as indicated |
| 59 | + in the file; or |
| 60 | +
|
| 61 | +(c) The contribution was provided directly to me by some other |
| 62 | + person who certified (a), (b) or (c) and I have not modified |
| 63 | + it. |
| 64 | +
|
| 65 | +(d) I understand and agree that this project and the contribution |
| 66 | + are public and that a record of the contribution (including all |
| 67 | + personal information I submit with it, including my sign-off) is |
| 68 | + maintained indefinitely and may be redistributed consistent with |
| 69 | + this project or the open source license(s) involved. |
| 70 | +``` |
| 71 | + |
| 72 | +Then you just add a line to every git commit message: |
| 73 | + |
| 74 | + Signed-off-by: Joe Smith <[email protected]> |
| 75 | + |
| 76 | +Use your real name (sorry, no pseudonyms or anonymous contributions.) |
| 77 | + |
| 78 | +If you set your `user.name` and `user.email` git configs, you can sign your |
| 79 | +commit automatically with `git commit -s`. |
0 commit comments