Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
    *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]>
  • Loading branch information
Jemale committed Dec 1, 2020
1 parent d4cf107 commit c6fa2cd
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 13 deletions.
65 changes: 65 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Contributing

We encourage anyone who wants to contribute 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).


Specific coding conventions and standards guidelines are a work-in-progress, and
we will post them here soon.

## 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 <[email protected]>

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`.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@ This repository contains the following components of oneAPI:
- Level Zero Validation Layer

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

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

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

The versions of the Level Zero API are listed in the file
[ze_api.h](./include/ze_api.h) in the `ze_api_version_t` enum.
Level Zero API versions are listed in the `ze_api_version_t` enumeration, located in the
[ze_api.h](./include/ze_api.h) file.

# Building and Installing

Expand Down Expand Up @@ -74,11 +72,14 @@ docker run \

# Contributing

We encourage anyone who wants to contribute 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/versions/latest/oneL0/index.html).
See [CONTRIBUTING](CONTRIBUTING.md) for more information.

Specific coding conventions and standards guidelines are a work-in-progress, and
we will post them here soon.
# License

Distributed under the MIT license. See [LICENSE](LICENSE.md) for more information.

# Security

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.

See also [SECURITY](SECURITY.md).
11 changes: 11 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Security Policy

## Report a Vulnerability

Please report security issues or vulnerabilities to the [Intel Security Center].

For more information on how Intel works to resolve security issues, see [Vulnerability Handling Guidelines].

[Intel Security Center]:https://www.intel.com/security

[Vulnerability Handling Guidelines]:https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html

0 comments on commit c6fa2cd

Please sign in to comment.