Skip to content

Update docs #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ vulnerability, do not raise a GitHub issue and follow the instructions in our
## Contributing code

We welcome your code contributions. Before submitting code via a pull request,
you will need to haved signed the [Oracle Contributor Agreement][OCA] (OCA) and
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:

Expand All @@ -35,14 +35,14 @@ can be accepted.

1. Ensure there is an issue created to track and discuss the fix or enhancement
you intend to submit.
1. Fork this repository
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`
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
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.

Expand All @@ -51,5 +51,5 @@ can be accepted.
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://www.oracle.com/technetwork/community/oca-486395.html
[OCA]: https://oca.opensource.oracle.com
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ declare the dependency in your project, ie:
</dependency>
```

# Installation
## Installation
Oracle R2DBC can be obtained from Maven Central.
```xml
<dependency>
Expand Down Expand Up @@ -78,7 +78,7 @@ Oracle R2DBC is compatible with JDK 11 (or newer), and has the following runtime
The Oracle R2DBC Driver has been verified with Oracle Database versions 18, 19,
and 21.

# Code Examples
## Code Examples

The following method returns an Oracle R2DBC `ConnectionFactory`
```java
Expand Down Expand Up @@ -143,31 +143,31 @@ is called.

Additional code examples can be found [here](sample).

# Help
## Help
For help programming with Oracle R2DBC, ask questions on Stack Overflow tagged with [[oracle] and [r2dbc]](https://stackoverflow.com/tags/oracle+r2dbc). The development team monitors Stack Overflow regularly.

Issues may be opened as described in [our contribution guide](CONTRIBUTING.md).

# Contributing
## Contributing

This project welcomes contributions from the community. Before submitting a pull
request, please [review our contribution guide](./CONTRIBUTING.md).

# Security
## Security

Please consult the [security guide](./SECURITY.md) for our responsible security
vulnerability disclosure process.

# License
## License

Copyright (c) 2021 Oracle and/or its affiliates.
Copyright (c) 2021, 2023 Oracle and/or its affiliates.

This software is dual-licensed to you under the Universal Permissive License
(UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License
2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
either license.

# Documentation
## Documentation
This document specifies the behavior of the R2DBC SPI as implemented for the
Oracle Database. This SPI implementation is referred to as the "Oracle R2DBC
Driver" or "Oracle R2DBC" throughout the remainder of this document.
Expand Down
19 changes: 9 additions & 10 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ 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
<mailto:[email protected]> preferably with a proof of concept. Please review
some additional information on [how to report security vulnerabilities to Oracle][1].
[[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][2].
[our encryption key][3].

We ask that you do not use other channels or contact the project maintainers
directly.
Expand All @@ -21,10 +21,8 @@ security features are welcome on GitHub Issues.

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. 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][3]
[Oracle Critical Patch Update][3] program. Additional
information, including past advisories, is available on our [security alerts][4]
page.

## Security-related information
Expand All @@ -34,6 +32,7 @@ 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]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
[2]: https://www.oracle.com/security-alerts/encryptionkey.html
[3]: https://www.oracle.com/security-alerts/
[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/