Skip to content

Commit 6ef3822

Browse files
authored
Initial commit
0 parents  commit 6ef3822

File tree

4 files changed

+174
-0
lines changed

4 files changed

+174
-0
lines changed

Diff for: CONTRIBUTING.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
*Detailed instructions on how to contribute to the project, if applicable. Must include section about Oracle Contributor Agreement with link and instructions*
2+
3+
# Contributing to this repository
4+
5+
We welcome your contributions! There are multiple ways to contribute.
6+
7+
## Opening issues
8+
9+
For bugs or enhancement requests, please file a GitHub issue unless it's
10+
security related. When filing a bug remember that the better written the bug is,
11+
the more likely it is to be fixed. If you think you've found a security
12+
vulnerability, do not raise a GitHub issue and follow the instructions in our
13+
[security policy](./SECURITY.md).
14+
15+
## Contributing code
16+
17+
We welcome your code contributions. Before submitting code via a pull request,
18+
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
19+
your commits need to include the following line using the name and e-mail
20+
address you used to sign the OCA:
21+
22+
```text
23+
Signed-off-by: Your Name <[email protected]>
24+
```
25+
26+
This can be automatically added to pull requests by committing with `--sign-off`
27+
or `-s`, e.g.
28+
29+
```text
30+
git commit --signoff
31+
```
32+
33+
Only pull requests from committers that can be verified as having signed the OCA
34+
can be accepted.
35+
36+
## Pull request process
37+
38+
1. Ensure there is an issue created to track and discuss the fix or enhancement
39+
you intend to submit.
40+
1. Fork this repository.
41+
1. Create a branch in your fork to implement the changes. We recommend using
42+
the issue number as part of your branch name, e.g. `1234-fixes`.
43+
1. Ensure that any documentation is updated with the changes that are required
44+
by your change.
45+
1. Ensure that any samples are updated if the base image has been changed.
46+
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
47+
what your changes are meant to do and provide simple steps on how to validate.
48+
your changes. Ensure that you reference the issue you created as well.
49+
1. We will assign the pull request to 2-3 people for review before it is merged.
50+
51+
## Code of conduct
52+
53+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
54+
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
55+
56+
[OCA]: https://oca.opensource.oracle.com
57+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

Diff for: LICENSE.txt

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Copyright (c) 2023 Oracle and/or its affiliates.
2+
3+
The Universal Permissive License (UPL), Version 1.0
4+
5+
Subject to the condition set forth below, permission is hereby granted to any
6+
person obtaining a copy of this software, associated documentation and/or data
7+
(collectively the "Software"), free of charge and under any and all copyright
8+
rights in the Software, and any and all patent rights owned or freely
9+
licensable by each licensor hereunder covering either (i) the unmodified
10+
Software as contributed to or provided by such licensor, or (ii) the Larger
11+
Works (as defined below), to deal in both
12+
13+
(a) the Software, and
14+
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
15+
one is included with the Software (each a "Larger Work" to which the Software
16+
is contributed by such licensors),
17+
18+
without restriction, including without limitation the rights to copy, create
19+
derivative works of, display, perform, and distribute the Software and make,
20+
use, sell, offer for sale, import, export, have made, and have sold the
21+
Software and the Larger Work(s), and to sublicense the foregoing rights on
22+
either these or other terms.
23+
24+
This license is subject to the following condition:
25+
The above copyright notice and either this complete permission notice or at
26+
a minimum a reference to the UPL must be included in all copies or
27+
substantial portions of the Software.
28+
29+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
32+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
33+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
34+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35+
SOFTWARE.

Diff for: README.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
*This repository acts as a template for all of Oracle’s GitHub repositories. It contains information about the guidelines for those repositories. All files and sections contained in this template are mandatory, and a GitHub app ensures alignment with these guidelines. To get started with a new repository, replace the italic paragraphs with the respective text for your project.*
2+
3+
# Project name
4+
5+
*Describe your project's features, functionality and target audience*
6+
7+
## Installation
8+
9+
*Provide detailed step-by-step installation instructions. You can name this section **How to Run** or **Getting Started** instead of **Installation** if that's more acceptable for your project*
10+
11+
## Documentation
12+
13+
*Developer-oriented documentation can be published on GitHub, but all product documentation must be published on <https://docs.oracle.com>*
14+
15+
## Examples
16+
17+
*Describe any included examples or provide a link to a demo/tutorial*
18+
19+
## Help
20+
21+
*Inform users on where to get help or how to receive official support from Oracle (if applicable)*
22+
23+
## Contributing
24+
25+
*If your project has specific contribution requirements, update the CONTRIBUTING.md file to ensure those requirements are clearly explained*
26+
27+
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
28+
29+
## Security
30+
31+
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
32+
33+
## License
34+
35+
*The correct copyright notice format for both documentation and software is*
36+
"Copyright (c) [year,] year Oracle and/or its affiliates."
37+
*You must include the year the content was first released (on any platform) and the most recent year in which it was revised*
38+
39+
Copyright (c) 2023 Oracle and/or its affiliates.
40+
41+
*Replace this statement if your project is not licensed under the UPL*
42+
43+
Released under the Universal Permissive License v1.0 as shown at
44+
<https://oss.oracle.com/licenses/upl/>.

Diff for: SECURITY.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Reporting security vulnerabilities
2+
3+
Oracle values the independent security research community and believes that
4+
responsible disclosure of security vulnerabilities helps us ensure the security
5+
and privacy of all our users.
6+
7+
Please do NOT raise a GitHub Issue to report a security vulnerability. If you
8+
believe you have found a security vulnerability, please submit a report to
9+
[[email protected]][1] preferably with a proof of concept. Please review
10+
some additional information on [how to report security vulnerabilities to Oracle][2].
11+
We encourage people who contact Oracle Security to use email encryption using
12+
[our encryption key][3].
13+
14+
We ask that you do not use other channels or contact the project maintainers
15+
directly.
16+
17+
Non-vulnerability related security issues including ideas for new or improved
18+
security features are welcome on GitHub Issues.
19+
20+
## Security updates, alerts and bulletins
21+
22+
Security updates will be released on a regular cadence. Many of our projects
23+
will typically release security fixes in conjunction with the
24+
Oracle Critical Patch Update program. Additional
25+
information, including past advisories, is available on our [security alerts][4]
26+
page.
27+
28+
## Security-related information
29+
30+
We will provide security related information such as a threat model, considerations
31+
for secure use, or any known security issues in our documentation. Please note
32+
that labs and sample code are intended to demonstrate a concept and may not be
33+
sufficiently hardened for production use.
34+
35+
[1]: mailto:[email protected]
36+
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
37+
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
38+
[4]: https://www.oracle.com/security-alerts/

0 commit comments

Comments
 (0)