diff --git a/.img/choose.png b/.img/choose.png deleted file mode 100644 index 23ade63ed8..0000000000 Binary files a/.img/choose.png and /dev/null differ diff --git a/.img/compare.png b/.img/compare.png deleted file mode 100644 index 7e85a5c61c..0000000000 Binary files a/.img/compare.png and /dev/null differ diff --git a/.img/create.png b/.img/create.png deleted file mode 100644 index 7cdf96681d..0000000000 Binary files a/.img/create.png and /dev/null differ diff --git a/.img/fork.png b/.img/fork.png deleted file mode 100644 index 7cd1e55525..0000000000 Binary files a/.img/fork.png and /dev/null differ diff --git a/.img/merge.png b/.img/merge.png deleted file mode 100644 index a744641385..0000000000 Binary files a/.img/merge.png and /dev/null differ diff --git a/.img/newpr.png b/.img/newpr.png deleted file mode 100644 index 3440b7f2ee..0000000000 Binary files a/.img/newpr.png and /dev/null differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..7eac329d6e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,79 @@ +# Contributing + +## Issues + +GitHub Issues tracks sample development issues, bugs, and feature requests. +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. + +When reporting a bug, please provide the following information, where applicable: + +* What are the steps to reproduce the bug? +* 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? +* What CPU/GPU, platform, operating system/distribution are you running? The more specific, the better. + + +### Contribution Guide + +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) + +* A PR should have a clear purpose, and do one thing only, and nothing more. This will enable us review your PR more quickly. +* Each commit in PR should be a small, atomic change representing one step in development. +* Please squash intermediate steps within PR for bugfixes, style cleanups, reversions, etc., so they would not appear in merged PR history. +* Please explain anything non-obvious from the code in comments, commit messages, or the PR description, as appropriate. +* Please follow [Git Steps for contribution](https://github.com/oneapi-src/oneAPI-samples/wiki/Git-Steps-for-Contribution). + +### License + +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. + +### Sign your work + +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 +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 you just add a line to every git commit message: + + Signed-off-by: Joe Smith + +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`. \ No newline at end of file diff --git a/License.txt b/License.txt new file mode 100644 index 0000000000..da5f7c1888 --- /dev/null +++ b/License.txt @@ -0,0 +1,7 @@ +Copyright 2019 Intel Corporation + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 7a7c4068c8..4d2106a4ab 100644 --- a/README.md +++ b/README.md @@ -1 +1,2 @@ -# oneAPI-samples \ No newline at end of file +# oneAPI-samples +This is the readme.