generated from oracle/template-repo
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 0333ba7
Showing
5 changed files
with
192 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
*Detailed instructions on how to contribute to the project, if applicable. Must include section about Oracle Contributor Agreement with link and instructions* | ||
|
||
# Contributing to this repository | ||
|
||
We welcome your contributions! There are multiple ways to contribute. | ||
|
||
## Opening issues | ||
|
||
For bugs or enhancement requests, please file a GitHub issue unless it's | ||
security related. When filing a bug remember that the better written the bug is, | ||
the more likely it is to be fixed. If you think you've found a security | ||
vulnerability, do not raise a GitHub issue and follow the instructions in our | ||
[security policy](./SECURITY.md). | ||
|
||
## Contributing code | ||
|
||
We welcome your code contributions. Before submitting code via a pull request, | ||
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and | ||
your commits need to include the following line using the name and e-mail | ||
address you used to sign the OCA: | ||
|
||
```text | ||
Signed-off-by: Your Name <[email protected]> | ||
``` | ||
|
||
This can be automatically added to pull requests by committing with `--sign-off` | ||
or `-s`, e.g. | ||
|
||
```text | ||
git commit --signoff | ||
``` | ||
|
||
Only pull requests from committers that can be verified as having signed the OCA | ||
can be accepted. | ||
|
||
## Pull request process | ||
|
||
1. Ensure there is an issue created to track and discuss the fix or enhancement | ||
you intend to submit. | ||
1. Fork this repository. | ||
1. Create a branch in your fork to implement the changes. We recommend using | ||
the issue number as part of your branch name, e.g. `1234-fixes`. | ||
1. Ensure that any documentation is updated with the changes that are required | ||
by your change. | ||
1. Ensure that any samples are updated if the base image has been changed. | ||
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly | ||
what your changes are meant to do and provide simple steps on how to validate. | ||
your changes. Ensure that you reference the issue you created as well. | ||
1. We will assign the pull request to 2-3 people for review before it is merged. | ||
|
||
## Code of conduct | ||
|
||
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd | ||
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC]. | ||
|
||
[OCA]: https://oca.opensource.oracle.com | ||
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
Copyright (c) 2022 Oracle and/or its affiliates. | ||
|
||
The Universal Permissive License (UPL), Version 1.0 | ||
|
||
Subject to the condition set forth below, permission is hereby granted to any | ||
person obtaining a copy of this software, associated documentation and/or data | ||
(collectively the "Software"), free of charge and under any and all copyright | ||
rights in the Software, and any and all patent rights owned or freely | ||
licensable by each licensor hereunder covering either (i) the unmodified | ||
Software as contributed to or provided by such licensor, or (ii) the Larger | ||
Works (as defined below), to deal in both | ||
|
||
(a) the Software, and | ||
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if | ||
one is included with the Software (each a "Larger Work" to which the Software | ||
is contributed by such licensors), | ||
|
||
without restriction, including without limitation the rights to copy, create | ||
derivative works of, display, perform, and distribute the Software and make, | ||
use, sell, offer for sale, import, export, have made, and have sold the | ||
Software and the Larger Work(s), and to sublicense the foregoing rights on | ||
either these or other terms. | ||
|
||
This license is subject to the following condition: | ||
The above copyright notice and either this complete permission notice or at | ||
a minimum a reference to the UPL must 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
*This repository acts as a template for all of Oracle’s GitHub repositories. To this end, it contains information about the guidelines for those repositories. All files and sections contained in this template are mandatory for all repositories. A GitHub app ensures alignment with the guidelines. To get started with a new repository, replace the italic paragraphs with the respective text for your project.* | ||
|
||
# Project name | ||
|
||
*Describe your project's features, functionality and target audience* | ||
|
||
## Installation | ||
|
||
*Provide detailed step-by-step installation instructions* | ||
|
||
## Documentation | ||
|
||
*Developer-oriented documentation can be published on GitHub, but all product documentation must be published on <https://docs.oracle.com>* | ||
|
||
## Examples | ||
|
||
*Describe any included examples or provide a link to a demo/tutorial* | ||
|
||
## Help | ||
|
||
*Inform users on where to get help or how to receive official support from Oracle (if applicable)* | ||
|
||
## Contributing | ||
|
||
*If your project has specific contribution requirements, update the CONTRIBUTING.md file to ensure those requirements are clearly explained* | ||
|
||
*This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)* | ||
|
||
## Security | ||
|
||
*Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process* | ||
|
||
## License | ||
|
||
*The correct copyright notice format for both documentation and software is* | ||
"Copyright (c) [year,] year Oracle and/or its affiliates." | ||
*You must include the year the content was first released (on any platform) and the most recent year in which it was revised* | ||
|
||
Copyright (c) 2022 Oracle and/or its affiliates. | ||
|
||
*Replace this statement if your project is not licensed under the UPL* | ||
|
||
Released under the Universal Permissive License v1.0 as shown at | ||
<https://oss.oracle.com/licenses/upl/>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
*Detailed instructions on how to report security vulnerabilities to Oracle.* ***Security vulnerabilities should not be discussed publicly on GitHub issues*** | ||
|
||
# Reporting security vulnerabilities | ||
|
||
Oracle values the independent security research community and believes that | ||
responsible disclosure of security vulnerabilities helps us ensure the security | ||
and privacy of all our users. | ||
|
||
Please do NOT raise a GitHub Issue to report a security vulnerability. If you | ||
believe you have found a security vulnerability, please submit a report to | ||
[[email protected]][1] preferably with a proof of concept. Please review | ||
some additional information on [how to report security vulnerabilities to Oracle][2]. | ||
We encourage people who contact Oracle Security to use email encryption using | ||
[our encryption key][3]. | ||
|
||
We ask that you do not use other channels or contact the project maintainers | ||
directly. | ||
|
||
Non-vulnerability related security issues including ideas for new or improved | ||
security features are welcome on GitHub Issues. | ||
|
||
## Security updates, alerts and bulletins | ||
|
||
Security updates will be released on a regular cadence. Many of our projects | ||
will typically release security fixes in conjunction with the | ||
[Oracle Critical Patch Update][3] program. Additional | ||
information, including past advisories, is available on our [security alerts][4] | ||
page. | ||
|
||
## Security-related information | ||
|
||
We will provide security related information such as a threat model, considerations | ||
for secure use, or any known security issues in our documentation. Please note | ||
that labs and sample code are intended to demonstrate a concept and may not be | ||
sufficiently hardened for production use. | ||
|
||
[1]: mailto:[email protected] | ||
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html | ||
[3]: https://www.oracle.com/security-alerts/encryptionkey.html | ||
[4]: https://www.oracle.com/security-alerts/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Copyright (c) [year,] year, Oracle and/or its affiliates. | ||
|
||
version: 0.1 | ||
component: build | ||
timeoutInSeconds: 1000 | ||
shell: bash | ||
|
||
steps: | ||
- type: Command | ||
name: "compress the repo" | ||
command: | | ||
tar -cvzf repo.tgz ./ | ||
outputArtifacts: | ||
- name: artifact | ||
type: BINARY | ||
location: ${OCI_PRIMARY_SOURCE_DIR}/repo.tgz |