Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Commit a8daaf0

Browse files
Merge pull request #53 from oracle/docs-updates
docs updates
2 parents ce7636a + 8e17005 commit a8daaf0

File tree

4 files changed

+115
-34
lines changed

4 files changed

+115
-34
lines changed

‎CONTRIBUTING.md‎

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,55 @@
1-
# Contributing to the OCI Service Broker
1+
# Contributing to this repository
22

3-
_Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved._
4-
_Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl._
3+
We welcome your contributions! There are multiple ways to contribute.
54

6-
Pull requests can be made under [The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (OCA).
5+
## Opening issues
76

8-
For pull requests to be accepted, the bottom of your commit message must have the following line using your name and e-mail address as it appears in the OCA Signatories list.
7+
For bugs or enhancement requests, please file a GitHub issue unless it's
8+
security related. When filing a bug remember that the better written the bug is,
9+
the more likely it is to be fixed. If you think you've found a security
10+
vulnerability, do not raise a GitHub issue and follow the instructions in our
11+
[security policy](./SECURITY.md).
912

10-
```plain
11-
Signed-off-by: Your Name <you@example.org>
13+
## Contributing code
14+
15+
We welcome your code contributions. Before submitting code via a pull request,
16+
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
17+
your commits need to include the following line using the name and e-mail
18+
address you used to sign the OCA:
19+
20+
```text
21+
Signed-off-by: Your Name <you@example.org>
1222
```
1323

14-
This can be automatically added to pull requests by committing with:
24+
This can be automatically added to pull requests by committing with `--sign-off`
25+
or `-s`, e.g.
1526

16-
```sh
17-
git commit --signoff
27+
```text
28+
git commit --signoff
1829
```
1930

20-
Only pull requests from committers that can be verified as having signed the OCA can be accepted.
31+
Only pull requests from committers that can be verified as having signed the OCA
32+
can be accepted.
33+
34+
## Pull request process
35+
36+
1. Ensure there is an issue created to track and discuss the fix or enhancement
37+
you intend to submit.
38+
1. Fork this repository.
39+
1. Create a branch in your fork to implement the changes. We recommend using
40+
the issue number as part of your branch name, e.g. `1234-fixes`.
41+
1. Ensure that any documentation is updated with the changes that are required
42+
by your change.
43+
1. Ensure that any samples are updated if the base image has been changed.
44+
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
45+
what your changes are meant to do and provide simple steps on how to validate.
46+
your changes. Ensure that you reference the issue you created as well.
47+
1. We will assign the pull request to 2-3 people for review before it is merged.
48+
49+
## Code of conduct
50+
51+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
52+
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
53+
54+
[OCA]: https://oca.opensource.oracle.com
55+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

‎LICENSE.txt‎

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,35 @@
1-
Oracle Cloud Infrastructure Service Broker
2-
Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
3-
4-
This software is licensed to you under the Universal Permissive License (UPL), Version 1.0.
1+
Copyright (c) 2019, 2023 Oracle and/or its affiliates.
52

63
The Universal Permissive License (UPL), Version 1.0
74

8-
Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of this
9-
software, associated documentation and/or data (collectively the "Software"), free of charge and under any and
10-
all copyright rights in the Software, and any and all patent rights owned or freely licensable by each licensor
11-
hereunder covering either (i) the unmodified Software as contributed to or provided by such licensor, or (ii)
12-
the Larger Works (as defined below), to deal in both
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
1312

1413
(a) the Software, and
15-
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if one is included with the Software
16-
(each a �Larger Work� to which the Software is contributed by such licensors),
17-
without restriction, including without limitation the rights to copy, create derivative works of, display, perform,
18-
and distribute the Software and make, use, sell, offer for sale, import, export, have made, and have sold the Software
19-
and the Larger Work(s), and to sublicense the foregoing rights on either these or other terms.
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),
2017

21-
This license is subject to the following condition:
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.
2223

23-
The above copyright notice and either this complete permission notice or at a minimum a reference to the UPL must be
24-
included in all copies or substantial portions of the Software.
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.
2528

26-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
27-
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
28-
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
29-
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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.

‎README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,11 @@ See [CHANGELOG](CHANGELOG.md).
4848

4949
## Contributing
5050

51-
`oci-service-broker` is an open source project. See [CONTRIBUTING](CONTRIBUTING.md) for details.
51+
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
5252

53-
Oracle gratefully acknowledges the contributions to `oci-service-broker` that have been made by the community.
53+
## Security
54+
55+
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
5456

5557
## License
5658

‎SECURITY.md‎

Lines changed: 38 additions & 0 deletions
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+
[secalert_us@oracle.com][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][3] 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:secalert_us@oracle.com
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)

AltStyle によって変換されたページ (->オリジナル) /