Skip to content

Commit 0f379ee

Browse files
Merge branch 'main' into bugfix/KVSTORE-1923
2 parents 24b6384 + bf8ba80 commit 0f379ee

File tree

4 files changed

+71
-31
lines changed

4 files changed

+71
-31
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,43 +3,54 @@
33

44
We welcome your contributions! There are multiple ways to contribute.
55

6-
## Issues
6+
## Opening issues
77

8-
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 on our [Security Policy](./SECURITY.md).
8+
For bugs or enhancement requests, please file a GitHub issue unless it's
9+
security related. When filing a bug remember that the better written the bug is,
10+
the more likely it is to be fixed. If you think you've found a security
11+
vulnerability, do not raise a GitHub issue and follow the instructions in our
12+
[security policy](./SECURITY.md).
913

10-
## Contributing Code
14+
## Contributing code
1115

12-
We welcome your code contributions. To get started, you will need to sign the [Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (OCA).
13-
14-
For pull requests to be accepted, the bottom of your commit message must have
15-
the following line using the name and e-mail address you used for the OCA.
16+
We welcome your code contributions. Before submitting code via a pull request,
17+
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
18+
your commits need to include the following line using the name and e-mail
19+
address you used to sign the OCA:
1620

1721
```text
1822
Signed-off-by: Your Name <you@example.org>
1923
```
2024

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

2328
```text
2429
git commit --signoff
2530
```
2631

27-
Only pull requests from committers that can be verified as having
28-
signed the OCA can be accepted.
32+
Only pull requests from committers that can be verified as having signed the OCA
33+
can be accepted.
2934

30-
### Pull request process
35+
## Pull request process
3136

32-
1. Fork this repository
37+
1. Ensure there is an issue created to track and discuss the fix or enhancement
38+
you intend to submit.
39+
1. Fork this repository.
3340
1. Create a branch in your fork to implement the changes. We recommend using
34-
the issue number as part of your branch name, e.g. `1234-fixes`
41+
the issue number as part of your branch name, e.g. `1234-fixes`.
3542
1. Ensure that any documentation is updated with the changes that are required
36-
by your fix.
43+
by your change.
3744
1. Ensure that any samples are updated if the base image has been changed.
3845
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
39-
what your changes are meant to do and provide simple steps on how to validate
40-
your changes. Ensure that you reference the issue you created as well.
46+
what your changes are meant to do and provide simple steps on how to validate.
47+
your changes. Ensure that you reference the issue you created as well.
4148
1. We will assign the pull request to 2-3 people for review before it is merged.
4249

43-
## Code of Conduct
50+
## Code of conduct
51+
52+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
53+
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
4454

45-
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](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
55+
[OCA]: https://oca.opensource.oracle.com
56+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
This LICENSES.txt file contains the license for the Oracle NoSQL Spring Data SDK.
22
A copy can be found at https://www.oracle.com/downloads/licenses/upl-license1.html.
33

4-
Copyright (c) 2014, 2016 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0
4+
Copyright (c) 2014, 2023 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0
55

66
Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of
77
this software, associated documentation and/or data (collectively the "Software"), free of charge and

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ API documentation.
5454

5555
## Documentation
5656

57-
See [Oracle NoSQL SDK for Spring Data javadoc](https://oracle.github.io/nosql-spring-sdk/) for the latest API documentation. See [Spring Data SDK Developers Guide](https://docs.oracle.com/en/database/other-databases/nosql-database/22.3/springsdk/index.html) for examples and additional details on the SDK.
57+
See [Oracle NoSQL SDK for Spring Data javadoc](https://oracle.github.io/nosql-spring-sdk/) for the latest API documentation. See [Spring Data SDK Developers Guide](https://docs.oracle.com/en/database/other-databases/nosql-database/23.1/springsdk/index.html) for examples and additional details on the SDK.
5858

5959
General documentation about the Oracle NoSQL Database Cloud Service, Oracle NoSQL Database and Spring Data SDK
6060
Developers Guide can be found in these locations:
@@ -137,7 +137,8 @@ Note: Depending on individual scenario use the appropriate AuthorizationProvider
137137
```
138138

139139
- For on-prem configuration use one of the following examples or see
140-
[documentation](https://docs.oracle.com/en/database/other-databases/nosql-database/22.3/admin/obtaining-nosql-handle.html).
140+
[documentation](https://docs.oracle.com/en/database/other-databases/nosql-database/23.1/admin/obtaining-nosql-handle.html).
141+
141142
* For unsecure example:
142143

143144
```java
@@ -315,13 +316,20 @@ Tests can be also be run on:
315316
mvn -B -Ptest-cloudsim test -DargLine="-Dtest.endpoint=$CLOUDSIM_ENDPOINT"
316317
```
317318
318-
## Licenses
319+
## License
319320
321+
Copyright (c) 2014б 2023 Oracle and/or its affiliates.
322+
Released under the Universal Permissive License v1.0 as shown at
323+
<https://oss.oracle.com/licenses/upl/>.
320324
See the [LICENSE](LICENSE.txt) file.
321325
322326
The [THIRD\_PARTY\_LICENSES](THIRD_PARTY_LICENSES.txt) file contains third
323327
party notices and licenses.
324328
329+
## Documentation
330+
* [API documentation](https://oracle.github.io/nosql-spring-sdk/)
331+
* [Developer's Guide](https://docs.oracle.com/en/database/other-databases/nosql-database/23.1/springsdk/index.html)
332+
325333
## Help
326334
327335
* Open an issue in the [Issues](https://github.com/oracle/nosql-spring-sdk/issues) page

SECURITY.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,38 @@
1-
# Reporting Security Vulnerabilities
1+
# Reporting security vulnerabilities
22

3-
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.
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.
46

5-
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 secalert_us@oracle.com preferably with a proof of concept. We provide additional information on [how to report security vulnerabilities to Oracle](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html) which includes public encryption keys for secure email.
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].
613

7-
We ask that you do not use other channels or contact project contributors directly.
14+
We ask that you do not use other channels or contact the project maintainers
15+
directly.
816

9-
Non-vulnerability related security issues such as new great new ideas for security features are welcome on GitHub Issues.
17+
Non-vulnerability related security issues including ideas for new or improved
18+
security features are welcome on GitHub Issues.
1019

11-
## Security Updates, Alerts and Bulletins
20+
## Security updates, alerts and bulletins
1221

13-
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](https://www.oracle.com/security-alerts/) program. Security updates are released on the Tuesday closest to the 17th day of January, April, July and October. A pre-release announcement will be published on the Thursday preceding each release. Additional information, including past advisories, is available on our [Security Alerts](https://www.oracle.com/security-alerts/) page.
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.
1427

15-
## Security-Related Information
28+
## Security-related information
1629

17-
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.
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)