Skip to content

Commit c6fa2cd

Browse files
committed
Update documentation
*Adds LICENSE and SECURITY sections to README *Add SECURITY.md for reporting security information *Add/update CONTRIBUTING for attribution information Signed-off-by: Jemale Lockett <[email protected]>
1 parent d4cf107 commit c6fa2cd

File tree

3 files changed

+90
-13
lines changed

3 files changed

+90
-13
lines changed

CONTRIBUTING.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing
2+
3+
We encourage anyone who wants to contribute to submit
4+
[Issues](https://github.com/oneapi-src/level-zero/issues) and
5+
[Pull Requests](https://github.com/oneapi-src/level-zero/pulls). We will help
6+
review these for proper alignment with the
7+
[Level Zero Specification](https://spec.oneapi.com/level-zero/latest/index.html).
8+
9+
10+
Specific coding conventions and standards guidelines are a work-in-progress, and
11+
we will post them here soon.
12+
13+
## Sign Your Work
14+
15+
Please use the sign-off line at the end of your patch. Your signature certifies
16+
that you wrote the patch or otherwise have the right to pass it on as an
17+
open-source patch. To do so, if you can certify the below
18+
(from [developercertificate.org](http://developercertificate.org/)):
19+
20+
```
21+
Developer Certificate of Origin
22+
Version 1.1
23+
24+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
25+
660 York Street, Suite 102,
26+
San Francisco, CA 94110 USA
27+
28+
Everyone is permitted to copy and distribute verbatim copies of this
29+
license document, but changing it is not allowed.
30+
31+
Developer's Certificate of Origin 1.1
32+
33+
By making a contribution to this project, I certify that:
34+
35+
(a) The contribution was created in whole or in part by me and I
36+
have the right to submit it under the open source license
37+
indicated in the file; or
38+
39+
(b) The contribution is based upon previous work that, to the best
40+
of my knowledge, is covered under an appropriate open source
41+
license and I have the right under that license to submit that
42+
work with modifications, whether created in whole or in part
43+
by me, under the same open source license (unless I am
44+
permitted to submit under a different license), as indicated
45+
in the file; or
46+
47+
(c) The contribution was provided directly to me by some other
48+
person who certified (a), (b) or (c) and I have not modified
49+
it.
50+
51+
(d) I understand and agree that this project and the contribution
52+
are public and that a record of the contribution (including all
53+
personal information I submit with it, including my sign-off) is
54+
maintained indefinitely and may be redistributed consistent with
55+
this project or the open source license(s) involved.
56+
```
57+
58+
Then add a line to every git commit message:
59+
60+
Signed-off-by: Kris Smith <[email protected]>
61+
62+
Use your real name (sorry, no pseudonyms or anonymous contributions).
63+
64+
If you set your `user.name` and `user.email` git configs, you can sign your
65+
commit automatically with `git commit -s`.

README.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,13 @@ This repository contains the following components of oneAPI:
77
- Level Zero Validation Layer
88

99
This project is part of the larger [oneAPI](https://www.oneapi.com/) project.
10-
See **Contributing** below for details about submitting issues and pull
11-
requests.
1210

13-
oneAPI Specification: https://spec.oneapi.com/versions/latest/introduction.html
11+
See the [oneAPI specification](https://spec.oneapi.com/versions/latest/introduction.html) for more information about the oneAPI project.
1412

15-
oneAPI Level Zero Specification: https://spec.oneapi.com/level-zero/1.0.4/index.html
13+
See the [Level Zero specification](https://spec.oneapi.com/level-zero/latest/index.html) for more information about Level Zero.
1614

17-
The versions of the Level Zero API are listed in the file
18-
[ze_api.h](./include/ze_api.h) in the `ze_api_version_t` enum.
15+
Level Zero API versions are listed in the `ze_api_version_t` enumeration, located in the
16+
[ze_api.h](./include/ze_api.h) file.
1917

2018
# Building and Installing
2119

@@ -74,11 +72,14 @@ docker run \
7472

7573
# Contributing
7674

77-
We encourage anyone who wants to contribute to submit
78-
[Issues](https://github.com/oneapi-src/level-zero/issues) and
79-
[Pull Requests](https://github.com/oneapi-src/level-zero/pulls). We will help
80-
review these for proper alignment with the
81-
[Level Zero Specification](https://spec.oneapi.com/versions/latest/oneL0/index.html).
75+
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
8276

83-
Specific coding conventions and standards guidelines are a work-in-progress, and
84-
we will post them here soon.
77+
# License
78+
79+
Distributed under the MIT license. See [LICENSE](LICENSE.md) for more information.
80+
81+
# Security
82+
83+
See Intel's [Security Center](https://www.intel.com/content/www/us/en/security-center/default.html) for information on how to report a potential security issue or vulnerability.
84+
85+
See also [SECURITY](SECURITY.md).

SECURITY.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Report a Vulnerability
4+
5+
Please report security issues or vulnerabilities to the [Intel Security Center].
6+
7+
For more information on how Intel works to resolve security issues, see [Vulnerability Handling Guidelines].
8+
9+
[Intel Security Center]:https://www.intel.com/security
10+
11+
[Vulnerability Handling Guidelines]:https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html

0 commit comments

Comments
 (0)